使用说明
项目简介
kintone MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在作为连接 LLM 客户端(如 Claude Desktop 应用)与 kintone 平台的桥梁。通过此服务器,用户可以使用自然语言指令,让 LLM 客户端调用 kintone 的 API,实现数据查询、记录操作、文件管理、应用配置等功能。该项目提供了一系列预定义的工具,方便用户快速集成和使用。
主要功能点
- 数据访问与操作: 支持对 kintone 应用中的记录进行检索、创建、更新和获取,方便 LLM 客户端获取和操作 kintone 数据。
- 文件管理: 允许 LLM 客户端上传文件到 kintone 或从 kintone 下载文件,扩展了 LLM 处理文件数据的能力。
- 应用信息查询: 提供查询 kintone 应用信息的功能,例如获取应用列表、表单布局等,帮助 LLM 理解 kintone 的数据结构。
- 空间和线程操作: 支持对 kintone 空间和线程进行管理,例如获取空间信息、更新空间设置、添加线程和评论等。
- 应用配置管理: 提供创建应用、添加字段、部署应用、更新应用设置和表单布局等功能,使 LLM 具备一定的 kintone 应用管理能力。
- 字段类型文档: 提供获取 kintone 字段类型文档的功能,辅助用户理解和配置 kintone 字段。
安装步骤
- 下载源代码: 从 GitHub 仓库下载 'kintone-mcp-server' 项目的源代码到本地。建议下载路径仅包含半角英数字,且不包含空格。
- 安装 Node.js: 确保你的系统已安装 Node.js 18 或更高版本。你可以从 Node.js 官网 下载并安装。
- 安装依赖: 在项目根目录下打开终端,运行 'npm install' 命令安装项目依赖。
服务器配置
要将 kintone MCP Server 配置到 MCP 客户端(例如 Claude Desktop 应用),你需要编辑客户端的配置文件(例如 'claude_desktop_config.json')。在 'mcpServers' 节点下添加一个新的服务器配置,配置信息如下:
{ "mcpServers": { "kintone": { // 服务器名称,可以自定义 "command": "node", // 启动服务器的命令,这里使用 node "env": { // 环境变量配置 "KINTONE_DOMAIN": "[你的kintone子域名].cybozu.com", // 替换为你的 kintone 子域名,例如 "example.cybozu.com" "KINTONE_USERNAME": "MCP连接使用的kintone用户名", // 替换为用于 MCP 连接的 kintone 用户名 "KINTONE_PASSWORD": "kintone用户密码(明文)" // 替换为 kintone 用户密码 (请注意安全性,生产环境不建议明文存储密码) }, "args": [ "[kintone-mcp-server 路径]/server.js" // 替换为 server.js 文件的绝对路径,例如 "/path/to/kintone-mcp-server/server.js" ] } } }
请注意:
- 你需要将上述配置中的占位符(例如 '[你的kintone子域名].cybozu.com', '[kintone-mcp-server 路径]/server.js')替换为你的实际信息。
- 'KINTONE_PASSWORD' 环境变量中使用了明文密码,在生产环境中请考虑使用更安全的凭证管理方式。
- 配置完成后,需要重启 MCP 客户端应用才能使配置生效。
基本使用方法
- 启动服务器: 配置完成后,当 MCP 客户端应用启动时,kintone MCP Server 会自动启动并运行在后台 (stdio 模式)。
- 在 MCP 客户端中使用: 在 Claude Desktop 或其他兼容的 MCP 客户端中,你可以通过自然语言指令调用 kintone MCP Server 提供的工具。例如,你可以询问 Claude: 'kintone 应用 “客户管理” 的应用ID是多少?' 或者 '在 kintone 应用 “项目管理” 中创建一个新的项目记录,项目名称为 “AI 项目”,负责人为 “张三”'。
- 查看功能列表: 你可以向 LLM 客户端询问 "kintone MCP server 提供了哪些工具?" 或类似的问题,LLM 应该能够列出服务器声明的工具列表及其描述。
示例功能验证:
启动服务器并配置客户端后,你可以尝试在 Claude 中输入以下指令进行功能验证:
'kintoneアプリ「你设置的kintone用户可以访问的应用名」のアプリIDを調べて' (日语) (请将 '你设置的kintone用户可以访问的应用名' 替换为你 kintone 中实际的应用名称,确保该用户有访问权限)
如果配置正确,Claude 应该能够返回指定 kintone 应用的 App ID。
信息
分类
商业系统