Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 30 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PocketSmith MCP Server

*Generated from [cyanheads/mcp-ts-template](https://github.com/cyanheads/mcp-ts-template)*
_Generated from [cyanheads/mcp-ts-template](https://github.com/cyanheads/mcp-ts-template)_

An MCP (Model Context Protocol) server for managing budgets via the PocketSmith API.

Expand All @@ -13,12 +13,14 @@ Built on the [cyanheads/mcp-ts-template](https://github.com/cyanheads/mcp-ts-tem
**⚠️ CRITICAL**: This server provides full access to your PocketSmith financial data. Please read our complete [Security Guide](SECURITY.md) before installation.

### Security Quick Start

- This server handles **highly sensitive financial data**
- Your PocketSmith API key provides **complete access** to your financial accounts
- Only use with **trusted MCP clients** and secure configurations
- **Enable confirmation prompts** for all financial operations

### Essential Security Checklist

- [ ] Read the complete [SECURITY.md](SECURITY.md) documentation
- [ ] Store API key in secure environment variables only
- [ ] Use stdio transport for single-user scenarios
Expand All @@ -30,19 +32,29 @@ Built on the [cyanheads/mcp-ts-template](https://github.com/cyanheads/mcp-ts-tem

## Quick Start

1. **Install dependencies**:
1. Clone `pocketsmith-ts` to `../pocketsmith-ts`

```bash
git clone https://github.com/joho/pocketsmith-ts.git
cd pocketsmith-ts
npm install
```

2. **Set up environment**: Copy `.env.example` to `.env` and add your PocketSmith API key
2. **Install dependencies in this repo**:

```bash
npm install
```

3. **Set up environment**: Copy `.env.example` to `.env` and add your PocketSmith API key

4. **Build**:

3. **Build**:
```bash
npm run build
```

4. **Run**:
5. **Run**:
```bash
npm run start:stdio # For MCP clients
npm run start:http # For web applications
Expand All @@ -51,42 +63,51 @@ Built on the [cyanheads/mcp-ts-template](https://github.com/cyanheads/mcp-ts-tem
## Available Tools

### Account Management

- `get_accounts` - View account balances and information
- `get_user_summary` - Comprehensive financial overview

### Transaction Management
### Transaction Management

- `get_transactions` - Search and filter transactions with advanced criteria
- `get_transaction` - Get detailed information about a specific transaction
- `create_transaction` - Add new transactions with categories and notes
- `update_transaction` - Modify existing transactions (change payee, amount, category, etc.)
- `delete_transaction` - Remove transactions (with confirmation)

### Category Management
- `get_categories` - View spending categories and hierarchies

- `get_categories` - View spending categories and hierarchies
- `create_category` - Add new spending categories with colors and parent relationships
- `update_category` - Modify existing categories (rename, recolor, reparent)

### Budget Analysis

- `get_budgets` - Analyze budget vs actual spending performance
- `get_budget_summary` - Detailed budget analysis with period breakdowns

### Recurring Events

- `get_recurring_events` - View scheduled/recurring transactions and income

### Attachments & Receipts

- `get_transaction_attachments` - View attachments for specific transactions
- `get_user_attachments` - View all user attachments across transactions
- `create_transaction_attachment` - Add receipts and documents to transactions

### Categorization Rules

- `get_category_rules` - View automatic categorization rules
- `create_category_rule` - Create rules for auto-categorizing transactions

### Account Details

- `get_account_transactions` - Get transactions for specific accounts
- `get_transaction_accounts` - Detailed transaction account information

### System Information

- `get_currencies` - View supported currencies and their formats
- `get_institutions` - View connected financial institutions

Expand All @@ -110,13 +131,13 @@ For Claude Desktop or other MCP clients:

---

*Built with ❤️ and the [Model Context Protocol](https://modelcontextprotocol.io/)*
_Built with ❤️ and the [Model Context Protocol](https://modelcontextprotocol.io/)_

---

# 🚀 Original MCP TypeScript Template Documentation

*The following documentation is from the original [cyanheads/mcp-ts-template](https://github.com/cyanheads/mcp-ts-template):*
_The following documentation is from the original [cyanheads/mcp-ts-template](https://github.com/cyanheads/mcp-ts-template):_

[![TypeScript](https://img.shields.io/badge/TypeScript-^5.8.3-blue.svg)](https://www.typescriptlang.org/)
[![Model Context Protocol SDK](https://img.shields.io/badge/MCP%20SDK-^1.15.1-green.svg)](https://github.com/modelcontextprotocol/typescript-sdk)
Expand Down
Loading