Content
Zaim MCP
**Unofficial** MCP server for Zaim's API. Allows access to Zaim's financial data from MCP clients like Claude Desktop.
> **Note**: This project is not affiliated with [Zaim](https://zaim.net/) and is developed and maintained by an individual.
## Requirements
- [Node.js](https://nodejs.org/) v18+
- [Zaim Developer Account](https://dev.zaim.net/) — Required for obtaining OAuth authentication information
## Setup
### 1. Obtain Zaim API Credentials
Register an application on [Zaim Developers](https://dev.zaim.net/) and obtain your Consumer Key and Consumer Secret.
### 2. Run the Setup Wizard
```sh
npx -y @highbridgedragon/zaim-mcp init
```
The wizard will guide you through:
1. Entering your Consumer Key and Consumer Secret
2. Logging in to Zaim via your browser to obtain an access token
3. Selecting the MCP client to use (Claude Desktop, Claude Code, Cursorsurf, VS Code)
4. Automatic writing of configuration files
After setup is complete, restart your MCP client to start using it.
### Manual Configuration
If you prefer not to use the wizard, add the following to your MCP client's configuration file:
**Claude Desktop** (`claude_desktop_config.json`):
```json
{
"mcpServers": {
"zaim": {
"command": "npx",
"args": ["-yhighbridgedragon/zaim-mcp"],
"env": {
"ZAIM_CONSUMER_KEY": "...",
"_CONSUMER_SECRET": "...",
"ZAIM_ACCESS_TOKEN": "...",
"ZAIM_SECRET": "..."
}
}
}
}
```
> On Windows, replace `"command": "npx", "args": ["-y", "@highbridgedragon/zaim-mcp"]` with `"command": "cmd", "args": ["/c", "npx", "-y", "@highbridgedragon/zaim-mcp"]`.
## Available Tools
| Tool | Description |
|------|-------------|
| `zaim_verify` | Verify authentication status and return user information |
| `zaim_get_money` | Retrieve financial records (filterable by date, category, and type) |
| `zaim_get_categories` | Retrieve user's category list |
| `zaim_get_genres` | Retrieve user's genre list |
| `zaim_get_accounts` | Retrieve user's account list |
| `zaim_get_default_categories` | Retrieve default category list |
| `zaim_get_currencies` | Retrieve available currency list |
## Development
Development requires Bun.
```sh
git clone https://github.com/HighBridgeDragon/zaim-mcp.git
cd zaim-mcp
bun run prepare
```
```sh
bun run start # Start MCP server
bun run test # Run unit tests
bun run check # Run lint, format, and typecheck
```
## License
[ISC](LICENSE)
