Files
nocobase-mcp/README.md
T

5.1 KiB
Raw Blame History

NocoBase CRM MCP

在你的电脑上,让 AI 客户端安全地查询 NocoBase CRM。安装时通过浏览器登录 NocoBase;每位用户使用自己的身份,看到的数据范围与本人在 NocoBase 中的权限一致。

安装

推荐把安装交给支持终端操作的 AI Agent 完成。你不需要克隆源码,也不需要逐条执行安装命令。

安装前准备

  • Node.js 20.11 或更高版本;
  • 能访问 https://justconn.top;
  • 你自己的 NocoBase 账号;
  • 能读取当前 Gitea 仓库对应 Release 的权限。

如果 Node.js 尚未安装,安装 Agent 会先说明需要进行的系统变更,并在获得你确认后再继续。

不需要提前创建或复制 Authorize Key。安装程序会打开 NocoBase 官方网页;你在网页中登录并确认授权后,本机安装会自动继续。

最快安装方式

  1. 打开当前 Gitea 仓库的 Releases(版本发布) 页面,选择要安装的固定版本。
  2. 确认该版本包含 npm 安装包和 SHA256SUMS,然后打开同一版本下的 INSTALL.md。不要使用默认分支中的安装说明代替固定版本。
  3. 把这个固定版本的 INSTALL.md 链接和下面的文字一起发给安装 Agent:
请按这个固定版本的安装协议帮我完成 NocoBase CRM MCP 本机安装。
默认只读;请运行 setup,让我只在 NocoBase 官方网页完成登录和授权。
不要向我索要密码、Token 或 Authorize Key,也不要静默安装系统工具。完成前请验证 crm_health 返回 ok=true。
  1. 浏览器打开后,在 justconn.top 登录并核对页面与终端显示的确认码,然后点击授权。浏览器没有自动打开时,复制终端显示的授权链接手动打开。
  2. 安装完成后,确认 Agent 报告 crm_health 返回 ok=true。

完整的安装和验收规则见 INSTALL.md。实际安装时应使用所选 Release Tag 中的同一文件。

重要注意事项

  • 只在 NocoBase 网页登录: 安装程序不会读取浏览器 Cookie,也不会接触你的密码;OAuth 令牌只保存到权限受限的个人凭据文件,不会进入聊天、命令参数、环境变量、CRM 配置、MCP 客户端配置或日志。
  • 默认只读: 安装后默认只能查询 CRM,不会创建、更新或删除业务数据。
  • 权限跟随本人: MCP 不会绕过 NocoBase 的角色、字段权限和行级权限,也不会使用共享管理员账号。
  • 只连接公司环境: 程序固定连接 https://justconn.top/api,不会要求你填写其他 NocoBase 地址。
  • 安装在用户目录: 不使用 sudo,不会全局安装本项目,也不需要 Git、Python、uv 或 nb CLI。
  • 受限仓库需要授权: 如果 Agent 无法读取 Gitea Release,请联系仓库管理员开通权限,不要把访问令牌发到聊天中。

安装后可以做什么

你可以直接让 AI:

  • 查询客户、联系人和跟进记录;
  • 按负责人、团队、状态或时间范围筛选 CRM 数据;
  • 查看 CRM 总览、团队贡献和长期未跟进客户;
  • 查看项目详情和项目跟进时间线。

例如:

列出我负责的、最近 30 天没有有效跟进的客户。
查看“华东团队”本月的客户、跟进和在途项目概况。

可选写入

只有在你明确需要创建或更新项目,并且管理员已经确认你的 NocoBase 权限时,才应启用写入模式。

写入模式只增加固定字段的项目创建和更新能力,不提供删除操作,也不开放任意集合或任意字段写入。不要为了绕过权限错误而换用共享高权限 Key。

遇到问题

  • 登录失效:重新运行安装程序的 setup,在浏览器中再次授权;正常情况下访问令牌会在后台自动刷新。
  • 浏览器没有打开:重新运行 setup --no-browser,然后手动打开终端显示的授权链接。
  • 仅在 OAuth 暂时不可用且管理员明确要求时,才使用 setup --manual-key 的隐藏输入备用模式;不要把 Key 发到聊天中。
  • 返回 NO_PERMISSIONS:请检查本人 NocoBase 角色和数据权限。
  • 请求超时:确认可以访问 https://justconn.top,或缩小查询范围。
  • Release 无法下载:确认当前账号或 Agent 已获得 Gitea 仓库和 Release 的读取权限。

更多故障处理和更新、回滚说明见 本机交付与权限验收。

更多文档

本地开发

开发者可从源码运行以下检查:

npm ci
npm run check
npm test
npm run build
node dist/index.js --help

本项目要求 Node.js 20.11 或更高版本。正式 Release 已将运行代码和依赖打包,最终用户不需要源码开发环境。