Zaim API

Provides OAuth 1.0a integration with Zaim, offering 14 tools to manage money data and master data via MCP.

typescript

GitHub Stars

typescript

Language

5 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "yone-k-zaim-api-mcp": {
      "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"
      ],
      "env": {
        "ZAIM_ACCESS_TOKEN": "your_access_token",
        "ZAIM_CONSUMER_KEY": "your_consumer_key",
        "ZAIM_CONSUMER_SECRET": "your_consumer_secret",
        "ZAIM_ACCESS_TOKEN_SECRET": "your_access_token_secret"
      }
    }
  }
}

You can run and use the Zaim API MCP Server to connect your Zaim data with MCP clients. It provides 14 tools to manage money records and master data, using OAuth 1.0a for authentication and TypeScript with strict validation for safety.

How to use

To use the Zaim API MCP Server, start the MCP runtime and point your MCP client at the server. You will authenticate with OAuth credentials and then call the available tools to fetch, create, update, or delete money records, as well as retrieve master data such as categories, genres, accounts, and currencies. Use the environment variables listed to supply your OAuth tokens and keys, and then perform operations through the corresponding tool endpoints by name.

How to install

Prerequisites: you should have Node.js 22 or newer for local development, and Docker is recommended for running the MCP server in isolation.

Install locally by following these steps.

Install dependencies

npm install

Start in development mode with the standard dev script

npm run dev

Run tests to verify everything is working

npm test

Build for production

npm run build

Optional Docker-based setup

Available tools

zaim_check_auth_status

Check the current OAuth authentication status and readiness to access Zaim data.

zaim_get_user_info

Retrieve information about the authenticated Zaim user.

zaim_get_money_records

Fetch money records with support for filtering and pagination.

zaim_create_payment

Create a new payment (expense) record.

zaim_create_income

Create a new income record.

zaim_create_transfer

Create a transfer between accounts.

zaim_update_money_record

Update an existing money record.

zaim_delete_money_record

Delete a money record.

zaim_get_user_categories

List user-specific categories.

zaim_get_user_genres

List user-specific 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.

Built by

VeilStrat

AI signals for GTM teams