Zaim API

This MCP server acts as a personal financial assistant by connecting the Zaim household account book service directly to AI environments. It allows users to manage their money through simple natural language conversations, making it easy to check balances, log daily expenses, or track income without ever leaving the chat interface. By bridging the gap between a popular budgeting tool and large language models, it transforms a standard accounting experience into an interactive, intelligent financial manager. Under the hood, the server provides a robust suite of 14 specialized tools designed for the full lifecycle management of financial records. It supports everything from retrieving historical transaction data with advanced filtering and pagination to creating, updating, and deleting entries for payments, income, and transfers. Beyond basic record-keeping, the server exposes master data such as user-specific categories, genres, and account details, ensuring that an AI assistant has the necessary context to categorize transactions accurately and maintain consistency with the user’s existing Zaim setup. For developers looking to build sophisticated financial AI agents, this project offers a production-ready implementation built on a type-safe TypeScript architecture. It handles the complexities of OAuth 1.0a authentication and implements strict Zod-based schema validation to ensure that data passed between the LLM and the Zaim API is always well-formatted and secure. With full Docker support and comprehensive test coverage, it provides a reliable foundation for creating intelligent assistants that can perform complex financial analysis, automate repetitive logging tasks, and provide personalized budgeting insights based on real-time data.

Category: CRM, ERP & E-commerce

Tags: accounting, budgeting, oauth, personal-finance, zaim

Visit Zaim API

How to install and configure Zaim API

1. Installation Prerequisites: - Node.js 22+ (for local development) - Docker (recommended) - Zaim API OAuth credentials (Consumer Key, Consumer Secret, Access Token, and Access Token Secret)

Docker (Recommended) bash # Clone the repository git clone https://github.com/yone-k/zaim-api-mcp.git cd zaim-api-mcp # Build the Docker image docker build -t zaim-api-mcp .

Local Development bash # Install dependencies npm install # Build the project npm run build ---

2. Configuration To use this server with Claude Desktop, edit your claude_desktop_config.json file: - macOS: ~/Library/Application Support/Claude/claude_desktop_config.json - Windows: %APPDATA%\Claude\claude_desktop_config.json

Option A: Docker Configuration (Recommended) json { "mcpServers": { "zaim-api": { "command": "docker", "args": [ "run", "--rm", "-i", "-e", "ZAIM_CONSUMER_KEY=your_consumer_key", "-e", "ZAIM_CONSUMER_SECRET=your_consumer_secret", "-e", "ZAIM_ACCESS_TOKEN=your_access_token", "-e", "ZAIM_ACCESS_TOKEN_SECRET=your_access_token_secret", "zaim-api-mcp" ] } } }

Option B: Local Build Configuration json { "mcpServers": { "zaim-api": { "command": "node", "args": ["/path/to/zaim-api-mcp/dist/index.js"], "env": { "ZAIM_CONSUMER_KEY": "your_consumer_key", "ZAIM_CONSUMER_SECRET": "your_consumer_secret", "ZAIM_ACCESS_TOKEN": "your_access_token", "ZAIM_ACCESS_TOKEN_SECRET": "your_access_token_secret" } } } } ---

3. Available Tools

Authentication & User Info - zaim_check_auth_status: Check authentication status. - zaim_get_user_info: Retrieve user information.

Transaction Operations - zaim_get_money_records: Get money records with filtering and pagination. - zaim_create_payment: Create a payment (expense) record. - zaim_create_income: Create an income record. - zaim_create_transfer: Create a transfer record. - zaim_update_money_record: Update an existing record. - zaim_delete_money_record: Delete a record.

Master Data - zaim_get_user_categories: List user categories. - zaim_get_user_genres: List user genres. - zaim_get_user_accounts: List user accounts. - zaim_get_default_categories: List default categories. - zaim_get_default_genres: List default genres. - zaim_get_currencies: List available currencies. ---

4. Example Prompts - "Please use zaim_check_auth_status to verify if the authentication is correctly configured." - "Use zaim_get_money_records to retrieve spending records for January 2024." - "Use zaim_create_payment to record a 1,500 yen lunch expense in the food category for today." - "Display the list of available categories using zaim_get_user_categories."

What you can do with Zaim API

Use Case 1: Natural Language Expense Logging Problem: Manually opening a mobile app, selecting categories, and typing in amounts for every small purchase (like a coffee or a bus fare) is tedious and often leads to users forgetting to log expenses. Solution: This MCP allows users to record expenses through a simple conversational interface. The AI can parse natural language, automatically identify the correct category or genre from the master data, and use zaim_create_payment to log the transaction instantly. Example: The user tells Claude: "I just spent 1,200 yen on a ramen lunch using my 'Cash' account." The AI calls zaim_get_user_categories to find the "Food" category ID and then calls zaim_create_payment with the amount, category, and account details.

Use Case 2: Monthly Spending Analysis and Budget Insights Problem: Reviewing monthly spending often requires exporting CSVs or navigating complex dashboards to understand where the money went across different categories. Solution: By using zaim_get_money_records combined with the AI’s analytical capabilities, users can ask complex questions about their financial habits. The AI can fetch data for a specific period, group it by category, and provide a summary or identify trends. Example: "How much did I spend on subscription services in the last three months compared to the previous period?" The AI fetches records from the last six months, filters for recurring keywords or specific categories, and calculates the difference for the user.

Use Case 3: Automated Transfer Reconciliation Problem: Tracking money moving between accounts (e.g., withdrawing cash from an ATM or moving money from a savings account to a credit card payment account) is a multi-step process in most UI-based apps. Solution: The MCP provides the zaim_create_transfer tool, which simplifies moving funds between internal accounts. The AI can look up the correct account IDs using zaim_get_user_accounts and execute the transfer in one command. Example: "I moved 50,000 yen from my 'Bank A' account to my 'PayPay' wallet today." The AI identifies the account IDs for both and creates the transfer record to ensure the balances remain accurate across all tracked accounts.

Use Case 4: Intelligent Category and Genre Cleanup Problem: Over time, household accounts can become messy with inconsistent categorization or unused genres, making long-term reporting difficult. Solution: Using the master data tools (zaim_get_user_categories, zaim_get_user_genres), the AI can audit the user's current setup. It can identify duplicate genres or suggest better categorization for specific records found via zaim_get_money_records. Example:…

Key facts

  • Open Source
  • CRM, ERP & E-commerce, Finance, Crypto & Payments
  • accounting, budgeting, oauth, personal-finance, zaim

Part of MCP Servers

Related MCP servers

  • MCP Microsoft Office Bridge — A secure, multi-user server connecting LLMs to Microsoft 365 services.
  • MCP Mempool — Access Bitcoin network data from mempool.space's API for AI agents and applications.
  • MCP NIF.PT — Query and analyze Portuguese companies using the NIF.PT public API. Supports search by NIF, company name, and city.
  • MCP Options Order Flow Server — A high-performance MCP server for comprehensive options order flow analysis.
  • MCP Open Library — A Model Context Protocol (MCP) server for the Open Library API that enables AI assistants to search for book and…
  • MCP Orlen Wholesale Price — Model Context Protocol Servers for Orlen Wholesale Price.
  • AI Tools
  • Categories
  • Industries
  • CLI Coding Agents
  • MCP Servers
  • MCP Categories