Macrat MCP Server Kintone

🚀 MCP Server for kintone

This is a Model Context Protocol (MCP) server for kintone. It allows you to explore and manipulate kintone data using AI tools such as Claude Desktop!

Chinese version: README.zh.md

🚀 Quick Start

📦 Installation

Download the latest version from the Releases page. You can place the executable file anywhere.

🛠️ Configure mcp-server-kintone

Create a configuration file similar to the following:

{
    "url": "https://<your-domain>.cybozu.com",
    "username": "<your-username>",
    "password": "<your-password>",
    "token": "<your-app-token-1>, <your-app-token-2>, ...",
    "apps": [
        {
            "id": "<your-app-id>",
            "description": "<your-app-description>",
            "permissions": {
                "read": true,
                "write": false,
                "delete": false
            }
        }
    ]
}

Configuration Parameters:

• url: (Required) The URL of the kintone domain.
• username: (Optional) The login username.
• password: (Optional) The login password.
• token: (Optional) The application tokens for login.
• apps: (Required) The list of applications to access.
  • id: (Required) The application ID.
  • description: (Optional) The description of the application for AI.
  • permissions: (Optional) The permissions for AI.
    • read: (Optional) Read permission. Default is true.
    • write: (Optional) Write permission. Default is false.
    • delete: (Optional) Delete permission. Default is false.

Notes:

• To connect to kintone, ensure that you provide at least one of username and password or token.
• Make sure all applications you want to access are in the apps list. For security reasons, this server does not allow clients to access applications not included in the apps list.

For example, your configuration file should look like this:

{
    "url": "https://example.cybozu.com",
    "username": "alice",
    "password": "password",
    "apps": [
        {
            "id": "1",
            "description": "An application for storing customer information. It includes the responsible person's name and contact information.",
            "permissions": {
                "read": true,
                "write": false,
                "delete": false
            }
        },
        {
            "id": "2",
            "description": "An application for storing project information. It includes the project overview and progress.",
            "permissions": {
                "read": true,
                "write": true,
                "delete": false
            }
        }
    ]
}

🛠️ Configure MCP Clients like Claude Desktop

Configure your client to connect to the server.

For Claude Desktop, edit the following file:

• MacOS/Linux: ~/Library/Application\ Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json

Add the following configuration to the mcpServers section:

{
  "mcpServers": {
    "kintone": {
      "command": "C:\\path\\to\\mcp-server-kintone.exe",
      "args": [
        "C:\\path\\to\\configuration.json"
      ]
    }
  }
}

You may need to restart Claude Desktop for the changes to take effect.

💪 Start Using

Now, you can interact with kintone using AI tools!

For example, you can say:

• "What is the current status of customer A's project?"
• "Update the progress of project B to 50%."
• "Show projects that are behind schedule."