使用说明

项目简介

Kintone Connector 是一个基于 Model Context Protocol (MCP) 构建的服务器,它充当 AI 工具(如 Claude Desktop)与 Kintone 之间的桥梁。通过这个服务器,AI 工具可以安全地访问和操作存储在 Kintone 中的企业数据,例如查询项目状态、更新进度、获取客户信息等。

主要功能点

  • 连接 Kintone 数据: 允许 AI 工具连接到您的 Kintone 环境。
  • 数据访问工具: 提供一系列工具,使 AI 工具能够:
    • 浏览应用列表: 查看 Kintone 中可用的应用程序。
    • 获取应用信息: 了解特定应用程序的详细信息,包括字段属性。
    • 记录管理: 创建、读取、更新和删除 Kintone 记录。
    • 附件管理: 上传和下载 Kintone 记录的附件文件。
    • 评论管理: 读取和创建记录的评论。
  • 权限控制: 支持通过环境变量配置允许或拒绝访问的 Kintone 应用,保障数据安全。

安装步骤

  1. 下载: 访问 release page 下载最新版本的 'mcp-server-kintone' 可执行文件。
  2. 放置: 将下载的可执行文件放在您电脑的任意位置。

服务器配置

要让 MCP 客户端(例如 Claude Desktop)连接到 Kintone Connector 服务器,您需要配置客户端的 MCP 服务器设置。以 Claude Desktop 为例,您需要编辑配置文件 'claude_desktop_config.json',文件路径如下:

  • 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",
      "env": {
        "KINTONE_BASE_URL": "https://<your-kintone-domain>.cybozu.com",
        "KINTONE_USERNAME": "<您的Kintone用户名>",
        "KINTONE_PASSWORD": "<您的Kintone密码>",
        "KINTONE_API_TOKEN": "<您的Kintone API Token (多个Token请用逗号分隔)>",
        "KINTONE_ALLOW_APPS": "允许访问的应用ID列表 (可选,用逗号分隔,默认允许所有应用)",
        "KINTONE_DENY_APPS": "禁止访问的应用ID列表 (可选,用逗号分隔,优先级高于允许列表)"
      }
    }
  }
}

配置参数说明 (在 'env' 字段中配置):

  • 'KINTONE_BASE_URL': (必填) 您的 Kintone 域名 (例如 'https://your-domain.cybozu.com')。
  • 'KINTONE_USERNAME': 您的 Kintone 用户名。
  • 'KINTONE_PASSWORD': 您的 Kintone 密码。
  • 'KINTONE_API_TOKEN': 您的 Kintone API Token。 注意: 您必须提供用户名/密码组合或 API Token 中的至少一种进行身份验证。 如果使用 API Token,可以提供多个,用逗号分隔。
  • 'KINTONE_ALLOW_APPS': 允许 AI 工具访问的 Kintone 应用 ID 列表。 如果设置,则只有列表中的应用可以被访问。 默认情况下,允许访问所有应用。
  • 'KINTONE_DENY_APPS': 禁止 AI 工具访问的 Kintone 应用 ID 列表。 如果设置,列表中的应用将无法被访问。 拒绝列表的优先级高于允许列表。

请注意:

  • 将 'command' 字段的值替换为您 'mcp-server-kintone.exe' 文件的实际路径。
  • 替换 '<your-kintone-domain>'、'<您的Kintone用户名>'、'<您的Kintone密码>'、'<您的Kintone API Token>' 为您的实际 Kintone 环境信息。
  • 修改配置文件后,可能需要重启 Claude Desktop 等 MCP 客户端才能使配置生效。

基本使用方法

配置完成后,您就可以在您的 AI 工具中与 Kintone 数据进行交互了。 例如,在 Claude Desktop 中,您可以尝试以下指令:

  • "Customer A's project 最新状态是什么?"
  • "将 Project B 的进度更新为 50%。"
  • "显示所有进度落后的项目。"

AI 工具会通过 Kintone Connector 服务器将您的指令转换为 Kintone API 调用,并返回结果。

信息

分类

商业系统