README
🚀 kintone 的 MCP 服务器
这是 kintone 的 Model Context Protocol (MCP) 服务器。借助该服务器,您能够使用 AI 工具(如 Claude Desktop)来探索和操作 kintone 数据!
中文版本:README.zh.md
🚀 快速开始
📦 安装指南
从 发布页面 下载最新版本。您可以将可执行文件放在任何位置。
💻 使用示例
基础用法
配置 mcp - server - kintone
创建一个类似以下的配置文件:
{
"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
}
}
]
}
配置参数:
| 属性 | 详情 |
|------|------|
| url | (必需)kintone 域的 URL。 |
| username | (可选)登录用户名。 |
| password | (可选)登录密码。 |
| token | (可选)用于登录的应用令牌。 |
| apps | (必需)要访问的应用列表。 |
| id | (必需,属于 apps 列表项)应用 ID。 |
| description | (可选,属于 apps 列表项)AI 的应用描述。 |
| permissions | (可选,属于 apps 列表项)AI 的权限。 |
| read | (可选,属于 permissions)读取权限。默认为 true。 |
| write | (可选,属于 permissions)写入权限。默认为 false。 |
| delete | (可选,属于 permissions)删除权限。默认为 false。 |
⚠️ 重要提示
- 要连接到 kintone,请确保提供
username和password或token中的至少一个。- 请确保所有要访问的应用都在
apps列表中。出于安全考虑,此服务器不允许客户端访问未包含在apps列表中的应用。
例如,您的配置文件应如下所示:
{
"url": "https://example.cybozu.com",
"username": "alice",
"password": "password",
"apps": [
{
"id": "1",
"description": "存储客户信息的应用。包含负责人姓名和联系方式。",
"permissions": {
"read": true,
"write": false,
"delete": false
}
},
{
"id": "2",
"description": "存储项目信息的应用。包含项目概述和进度情况。",
"permissions": {
"read": true,
"write": true,
"delete": false
}
}
]
}
配置 MCP 客户端,如 Claude Desktop
配置您的客户端以连接到服务器。
对于 Claude Desktop,请编辑以下文件:
- MacOS/Linux:
~/Library/Application\ Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
在 mcpServers 部分添加以下配置:
{
"mcpServers": {
"kintone": {
"command": "C:\\path\\to\\mcp-server-kintone.exe",
"args": [
"C:\\path\\to\\configuration.json"
]
}
}
}
您可能需要重新启动 Claude Desktop 才能使更改生效。
开始使用
现在,您可以使用 AI 工具与 kintone 进行交互了!
例如,您可以这样说:
- “客户 A 的项目当前状态如何?”
- “将项目 B 的进度更新为 50%。”
- “显示滞后于计划的项目。”
Scan to contact