项目简介

kintone MCP 服务器是专为大语言模型(LLM)客户端设计,用于安全、标准化地访问和管理kintone平台的数据和功能。它将kintone的API操作封装为LLM可调用的工具,支持上下文信息获取、数据读写和流程管理,并通过Model Context Protocol (MCP) 实现LLM与kintone之间的智能交互。

主要功能点

  • kintone数据访问: 允许LLM获取kintone应用(App)的列表、详细信息、表单字段配置和流程管理设置。
  • kintone记录操作: 支持LLM对kintone应用中的记录进行查询、添加、更新和删除操作。
  • 流程状态管理: 允许LLM更新kintone记录的流程状态,以自动化业务流程。
  • 安全认证: 支持多种认证方式,包括用户名/密码、API令牌、Basic认证和客户端证书认证,确保对kintone的访问安全可靠。
  • 灵活部署: 可作为npm包、Docker容器或Claude Desktop扩展进行部署。
  • 标准化协议: 通过JSON-RPC协议与LLM客户端通信,遵循MCP标准,提供统一的上下文服务框架。

安装步骤

有多种方式可以安装和运行 kintone MCP 服务器,请选择您最方便的方式:

  1. 作为 Claude Desktop 扩展 (DXT 文件):

    • 访问 发布页面,下载最新版本的 'kintone-mcp-server.dxt' 文件。
    • 打开 Claude Desktop 应用,进入“设置” -> “桌面应用” -> “扩展功能”页面。
    • 将下载的 '.dxt' 文件拖放到 Claude Desktop 窗口中。
    • 根据提示安装并配置您的 kintone 基础URL、用户名和密码。
  2. 使用 Docker 容器:

    • 确保您已安装 Docker。
    • 运行以下命令启动服务器,并替换为您的 kintone 环境信息:
      docker run -i --rm \
        -e KINTONE_BASE_URL=https://您的域名.cybozu.com \
        -e KINTONE_USERNAME=您的kintone用户名 \
        -e KINTONE_PASSWORD=您的kintone密码 \
        ghcr.io/kintone/mcp-server:latest
  3. 作为 npm 包:

    • 确保您已安装 Node.js。
    • 全局安装 npm 包:
      npm install -g @kintone/mcp-server
    • 运行以下命令启动服务器,并替换为您的 kintone 环境信息:
      kintone-mcp-server \
        --base-url https://您的域名.cybozu.com \
        --username 您的kintone用户名 \
        --password 您的kintone密码
      (您也可以通过设置环境变量 'KINTONE_BASE_URL'、'KINTONE_USERNAME'、'KINTONE_PASSWORD' 来提供配置。)

服务器配置 (供MCP客户端连接)

MCP 客户端需要通过一个JSON格式的配置文件来了解如何启动并连接到 kintone MCP 服务器。以下是一个示例配置,您需要根据您的 LLM 客户端(如 Claude Code 或 Cursor)的文档,将其保存为相应的配置文件(例如 '.mcp.json' 或 '.cursor/mcp.json'):

{
  "mcpServers": {
    "kintone": {
      "type": "stdio",
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "KINTONE_BASE_URL",
        "-e",
        "KINTONE_USERNAME",
        "-e",
        "KINTONE_PASSWORD",
        "ghcr.io/kintone/mcp-server:latest"
      ],
      "cwd": "${cwd}",
      "env": {
        "KINTONE_BASE_URL": "https://您的kintone域名.cybozu.com",
        "KINTONE_USERNAME": "您的kintone用户名",
        "KINTONE_PASSWORD": "您的kintone密码"
      }
    }
  }
}

配置参数注释:

  • 'mcpServers': 包含所有 MCP 服务器配置的根对象。
  • 'kintone': 这是您为该 MCP 服务器实例自定义的名称。
  • 'type': 指明 MCP 服务器使用的传输协议类型。本服务器支持 'stdio' (标准输入输出)。
  • 'command': 告诉 LLM 客户端如何启动 MCP 服务器的可执行命令。
    • 如果您使用 Docker 部署,这里通常是 '"docker"'。
    • 如果您使用 npm 全局包,这里通常是 '"kintone-mcp-server"'。
  • 'args': 传递给 'command' 的参数列表。
    • 对于 Docker,这包括 'run' 命令、交互式模式 '-i'、自动移除 '--rm'、环境变量设置 '-e' 以及 Docker 镜像名称 'ghcr.io/kintone/mcp-server:latest'。
    • 如果您使用 npm 全局包,这里应包含 '--base-url'、'--username'、'--password' 等命令行参数。
  • 'cwd': 启动命令的工作目录。'"${cwd}"' 是一个占位符,表示使用客户端当前的工作目录。
  • 'env': 在启动 MCP 服务器时设置的环境变量。您可以在这里直接提供 kintone 的连接信息。
    • 'KINTONE_BASE_URL': 您的 kintone 环境的根 URL,例如 'https://example.cybozu.com'。
    • 'KINTONE_USERNAME': 您的 kintone 登录用户名。
    • 'KINTONE_PASSWORD': 您的 kintone 登录密码。
    • 替代认证方式: 您也可以使用 'KINTONE_API_TOKEN' 来代替 'KINTONE_USERNAME' 和 'KINTONE_PASSWORD' 进行认证。如果同时指定,用户名和密码认证将优先。

基本使用方法

配置好 MCP 客户端后,您的 LLM 即可通过调用 kintone MCP 服务器提供的工具来与 kintone 平台进行交互。例如,LLM 可以:

  • 获取应用列表: 调用 'kintone-get-apps' 工具,查询可用的 kintone 应用。
  • 查询记录: 调用 'kintone-get-records' 工具,并指定应用 ID 和过滤条件来获取数据。
  • 添加新记录: 调用 'kintone-add-records' 工具,提供应用 ID 和新记录的数据。
  • 更新记录状态: 调用 'kintone-update-statuses' 工具,以推动 kintone 应用中的业务流程。

具体如何让 LLM 调用这些工具,请参考您所使用的 LLM 客户端(如 Claude Code 或 Cursor)的官方文档。

信息

分类

商业系统