joho/pocketsmith-mcp

开发工具

本页由 AI 翻译，技术细节请以原文为准。查看原文

11 stars 5 forks 质量 65 趋势 18Apache-2.0

Repository Install

MCP for managing your budget etc with pocketsmith

概览

Generated from cyanheads/mcp-ts-template An MCP (Model Context Protocol) server for managing budgets via the PocketSmith API. Built on the cyanheads/mcp-ts-template, this server follows a modular architecture with robust error handling, logging, and security features while providing comprehensive PocketSmith integration. See POCKETSMITH_README.md for complete PocketSmith-specific documentation. : This server provides full access to your PocketSmith financial data. Please read our complete Security Guide before installation. - This server handles - Your PocketSmith API key provides to your financial accounts - Only use with and secure configurations - for all financial operations - [ ] Read the complete SECURITY.

README

以下为原文 README 节选，完整内容请查看原文。

PocketSmith MCP Server

Generated from cyanheads/mcp-ts-template

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

Built on the cyanheads/mcp-ts-template, this server follows a modular architecture with robust error handling, logging, and security features while providing comprehensive PocketSmith integration.

See POCKETSMITH_README.md for complete PocketSmith-specific documentation.

🔒 Security Considerations

⚠️ CRITICAL: This server provides full access to your PocketSmith financial data. Please read our complete Security Guide 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 documentation
[ ] Store API key in secure environment variables only
[ ] Use stdio transport for single-user scenarios
[ ] Never add financial operations to auto-approve lists
[ ] Set up regular API key rotation (recommended: every 90 days)
[ ] Monitor your PocketSmith account for unauthorized changes

🚨 Never share your API key or use this server on untrusted systems.

Quick Start

Install dependencies:
```
npm install
```
Set up environment: Copy .env.example to .env and add your PocketSmith API key
Build:
```
npm run build
```

Run:

npm run start:stdio  # For MCP clients
npm run start:http   # For web applications

Available Tools

Account Management

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

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
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

在 GitHub 查看完整 README

安装

This server does not publish a one-line install command.

Open the repository installation guide 新手？先看 mcpskill.org 教程 →

配置

{
  "mcpServers": {
    "pocketsmith": {
      "command": "node",
      "args": ["/path/to/pocketsmith-mcp/dist/index.js"],
      "env": {
        "POCKETSMITH_API_KEY": "your_api_key_here"
      }
    }
  }
}