Skip to main content

Production-ready MCP server for PocketSmith personal finance API

Project description

PocketSmith MCP Server

A production-ready MCP server for the PocketSmith personal finance API

PocketSmith MCP Demo

Python 3.10+ License: MIT PyPI Tests: 148 passed Coverage: 84%

FeaturesQuick StartToolsTestingDevelopment


Features

  • 43 MCP Tools - Complete coverage of PocketSmith API v2 endpoints
  • Production Ready - Rate limiting, retry with exponential backoff, circuit breaker
  • Universal Compatibility - Works with Claude Desktop, Cursor, and any MCP-compatible client
  • Type Safe - Pydantic models for all API entities

Quick Start

Installation

# Run directly with uvx (recommended)
uvx pocketsmith-mcp

# Or install with pip
pip install pocketsmith-mcp

Getting Your API Key

  1. Navigate to Security & Integrations - Click your profile icon, then select "Security & integrations"

Navigate to Security & Integrations

  1. Create a Developer Key - Go to "Manage developer keys" and click "Create Key"

Create Developer Key

Configuration

  1. Set your environment variable:
export POCKETSMITH_API_KEY=your_api_key_here
  1. Run the server:
uvx pocketsmith-mcp

Claude Desktop Integration

Add to your Claude Desktop config:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "pocketsmith": {
      "command": "uvx",
      "args": ["pocketsmith-mcp"],
      "env": {
        "POCKETSMITH_API_KEY": "your_api_key_here"
      }
    }
  }
}

Available Tools

User Management
Tool Description
get_current_user Get authenticated user info
get_user Get user by ID
update_user Update user settings
Account Management
Tool Description
list_accounts List all accounts
get_account Get account details
update_account Update account
delete_account Delete account
Transaction Accounts
Tool Description
list_transaction_accounts List transaction accounts
get_transaction_account Get transaction account details
update_transaction_account Update transaction account
Transactions
Tool Description
list_transactions List transactions with filters
get_transaction Get transaction details
create_transaction Create new transaction
update_transaction Update transaction
delete_transaction Delete transaction
Categories
Tool Description
list_categories List all categories
get_category Get category details
create_category Create new category
update_category Update category
delete_category Delete category
Budgeting
Tool Description
get_budget Get budget data
get_budget_summary Get budget summary
get_trend_analysis Get spending trends
clear_forecast_cache Clear forecast cache
Institutions
Tool Description
list_institutions List financial institutions
get_institution Get institution details
create_institution Create institution
update_institution Update institution
delete_institution Delete institution
Events (Budget Calendar)
Tool Description
list_events List budget events
get_event Get event details
create_event Create budget event
update_event Update event
delete_event Delete event
Attachments
Tool Description
list_attachments List attachments
get_attachment Get attachment details
create_attachment Upload attachment
update_attachment Update attachment
delete_attachment Delete attachment
Labels & Searches
Tool Description
list_labels List all labels
list_saved_searches List saved searches
Utilities
Tool Description
list_currencies List supported currencies
list_time_zones List supported time zones

Testing

Running Tests

# Run all tests
uv run pytest

# Run with coverage report
uv run pytest --cov=src/pocketsmith_mcp --cov-report=term-missing

# Run specific test file
uv run pytest tests/unit/tools/test_transactions.py

# Run tests by marker
uv run pytest -m unit          # Unit tests only
uv run pytest -m integration   # Integration tests only
uv run pytest -m e2e           # End-to-end tests (requires API key)

Test Structure

tests/
├── unit/                 # Fast, isolated tests with mocked API
│   ├── test_api_client.py
│   ├── test_rate_limiter.py
│   ├── test_circuit_breaker.py
│   └── tools/            # Tool-specific unit tests
├── integration/          # Tests with mocked HTTP responses
│   ├── test_server.py
│   └── test_tools.py
└── conftest.py           # Shared fixtures

Coverage

The project maintains a 70% coverage threshold. Coverage reports are generated automatically:

uv run pytest --cov=src/pocketsmith_mcp --cov-report=html
open htmlcov/index.html

Development

Setup

# Clone the repository
git clone https://github.com/ajanderson1/mcp_pocketsmith.git
cd pocketsmith-mcp

# Install dependencies (including dev)
uv sync --dev

# Copy environment template
cp .env.example .env
# Edit .env and add your API key

Architecture

pocketsmith-mcp/
├── src/pocketsmith_mcp/
│   ├── __main__.py       # Entry point
│   ├── server.py         # FastMCP server setup
│   ├── config.py         # Environment configuration
│   ├── client/           # API client with resilience patterns
│   │   ├── api_client.py     # HTTP client wrapper
│   │   ├── rate_limiter.py   # Token bucket algorithm
│   │   ├── circuit_breaker.py # Fault tolerance
│   │   └── retry.py          # Exponential backoff
│   ├── models/           # Pydantic data models
│   └── tools/            # MCP tool implementations
└── tests/                # Unit and integration tests

API Resilience

The client includes production-grade resilience:

  • Rate Limiting - Token bucket algorithm (60 req/min default)
  • Retry Logic - Exponential backoff with jitter for transient failures
  • Circuit Breaker - Prevents cascade failures during outages

Environment Variables

Variable Required Default Description
POCKETSMITH_API_KEY Yes - Your PocketSmith API key
DEBUG No false Enable debug logging
API_TIMEOUT No 30 Request timeout (seconds)
MAX_RETRIES No 3 Retry attempts for failed requests
RATE_LIMIT_PER_MINUTE No 60 API rate limit

License

This project is licensed under the MIT License - see the LICENSE file for details.


Made with Python and FastMCP

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pocketsmith_mcp-1.0.1.tar.gz (3.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pocketsmith_mcp-1.0.1-py3-none-any.whl (39.9 kB view details)

Uploaded Python 3

File details

Details for the file pocketsmith_mcp-1.0.1.tar.gz.

File metadata

  • Download URL: pocketsmith_mcp-1.0.1.tar.gz
  • Upload date:
  • Size: 3.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for pocketsmith_mcp-1.0.1.tar.gz
Algorithm Hash digest
SHA256 5cb0661e82a45c6ee8356241a59d34b35aaae65a0834a40d05125e5194aea607
MD5 bb21cba112acba5638d83640975634d0
BLAKE2b-256 2cecb2eaaaf5d88cc09f7e8d6fc6f448b301527f9bcdb05e16cdccf019329c4b

See more details on using hashes here.

File details

Details for the file pocketsmith_mcp-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: pocketsmith_mcp-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 39.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for pocketsmith_mcp-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 87a96f35a4f565a7fad310923b3dbd6af512dcac58f59c419a63cdf33dbf4c24
MD5 62ea9999fdf108aa96279f3e98e45d8c
BLAKE2b-256 fe4d281b1957023707e68e574bb0c53ac2c4c54b2e187d565ebfde2f79b9f62e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page