Zaim API

by yone-k

Not rated
GitHub

About

A server template for interacting with APIs that require an API key, using the Zaim API as an example.

Details

Author
yone-k
Categories
Developer Tools, API, Finance

Setup

Install Zaim API in your MCP client (Claude Desktop, Cursor, Windsurf, and others).

Repository: https://github.com/yone-k/zaim-api-mcp

Follow the installation instructions in the repository README, then restart your MCP client.

Zaim APIとの連携を可能にするMCP (Model Context Protocol) サーバーです。OAuth 1.0a認証を使用してZaimの家計簿データの取得・操作を行います。

- Zaim API(OAuth 1.0a)との完全な統合
- 14個の包括的なツールセット
- 家計簿データの取得・作成・更新・削除
- マスターデータ(カテゴリ、ジャンル、口座、通貨)の取得
- TypeScriptベースの型安全な実装
- Zodスキーマによる厳密なバリデーション
- 包括的なテストカバレッジ(128テスト)
- Dockerサポート

- zaim_check_auth_status- 認証状態の確認
- zaim_get_user_info- ユーザー情報の取得

- zaim_get_money_records- 家計簿記録の取得(フィルタリング・ページネーション対応)
- zaim_create_payment- 支出記録の作成
- zaim_create_income- 収入記録の作成
- zaim_create_transfer- 振替記録の作成
- zaim_update_money_record- 既存記録の更新
- zaim_delete_money_record- 記録の削除

- zaim_get_user_categories- ユーザーカテゴリ一覧
- zaim_get_user_genres- ユーザージャンル一覧
- zaim_get_user_accounts- ユーザー口座一覧
- zaim_get_default_categories- デフォルトカテゴリ一覧
- zaim_get_default_genres- デフォルトジャンル一覧
- zaim_get_currencies- 利用可能通貨一覧

- Docker(推奨)
- Node.js 22+(ローカル開発時)
- Zaim APIのOAuth認証情報

- Consumer Key
- Consumer Secret
- Access Token
- Access Token Secret

# 必須:Zaim API認証情報 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
# リポジトリをクローン git clone https://github.com/yone-k/zaim-api-mcp.git cd zaim-api-mcp # Dockerイメージをビルド docker build -t zaim-api-mcp .
# 依存関係をインストール npm install # 開発モードで開始 npm run dev # テスト実行 npm test # ビルド npm run build

macOS:~/Library/Application Support/Claude/claude_desktop_config.json
Windows:%APPDATA%\Claude\claude_desktop_config.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" ] } } }
{ "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" } } } }
zaim_check_auth_status を使って認証が正しく設定されているか確認してください
zaim_get_money_records を使って、2024年1月の支出記録を取得してください
zaim_create_payment を使って、本日1,500円の昼食代を食費カテゴリで記録してください
zaim_get_user_categories を使って利用可能なカテゴリ一覧を表示してください
zaim-api-mcp/ ├── src/ │ ├── core/ # MCPサーバーコア機能 │ │ ├── tool-handler.ts │ │ └── zaim-api-client.ts │ ├── tools/ # ツール実装 │ │ ├── auth/ # 認証関連ツール │ │ ├── money/ # 家計簿データツール │ │ ├── master/ # マスターデータツール │ │ └── registry.ts # ツール登録 │ ├── types/ # 型定義 │ ├── utils/ # ユーティリティ │ └── index.ts # エントリーポイント ├── tests/ # テストファイル ├── config/ # 設定ファイル └── docker-compose.yml # Docker設定

- 機能ごとにブランチを作成
- TDD(テスト駆動開発)で実装
- すべてのテストが通ることを確認
- プルリクエストを作成

feat: 新機能の追加 fix: バグ修正 docs: ドキュメントの変更 refactor: リファクタリング test: テストの追加・修正 chore: ビルドプロセスやツールの変更
npm run build # TypeScriptビルド npm run start # 本番サーバー起動 npm run dev # 開発サーバー起動 npm run lint # ESLint実行 npm run typecheck # 型チェック npm test # テスト実行 npm run test:watch # テスト監視モード npm run test:coverage # カバレッジレポート npm run docker:build # Dockerイメージビルド npm run docker:run # Dockerコンテナ実行 npm run docker:dev # Docker Compose起動

- 環境変数が正しく設定されているか確認
- Zaim開発者サイトでアプリケーションの設定を確認
- アクセストークンの有効期限を確認

- Dockerデーモンが起動しているか確認
- 環境変数が正しく渡されているか確認
- ログで詳細なエラーメッセージを確認
- リポジトリをフォーク
- フィーチャーブランチを作成 (git checkout -b feat/amazing-feature)
- 変更をコミット (git commit -m 'feat: 素晴らしい機能を追加')
- ブランチをプッシュ (git push origin feat/amazing-feature)
- プルリクエストを作成

This is a web browser that enables your coding agent, such as Claude Code, to visit websites on your behalf and assist you in identifying bugs or creating UI test cases.

Integrate AI tools and agents with Cashfree's Payment Gateway, Payouts, and SecureID APIs.

Provides JSON-RPC functionality through the OpenRPC specification.

One shared context layer for AI agents and humans — live API specs, DB schemas, and versioned contracts across repos so every agent and teammate works from the same source of truth.

The MCP server for Bitrix24 provides AI assistants with structured access to the Bitrix24 API. It delivers up-to-date method descriptions, parameters, and valid values, allowing assistants to work with precise data instead of guesswork. This reduces code errors and accelerates Bitrix24 integration development.

Tool platform by IBM to build, test and deploy tools for any data source

MCP server for Klever blockchain smart contract development, on-chain data exploration, and VM interaction. Public remote server available at https://mcp.klever.org/mcp.

One remote MCP server for 500+ production APIs — Stripe, HubSpot, Postgres, Gmail, and more. OAuth and API key auth, credential management, and a CLI.

An MCP server for interacting with the Postman API, requiring an API key.

Arbitrary code execution and tool-use platform for LLMs by Riza

A command-line tool for interacting with Shopify's Admin GraphQL API, Functions, and Polaris Web Components.

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.