nocobase-mcp-server

一个用于 NocoBase 的 MCP（模型上下文协议）服务器，使 Claude 等 AI 助手能够与您的 NocoBase 实例进行交互——读取集合、管理 UI 模式、构建 flowPage 区块，并通过 OpenAPI 运行动态 API 操作。

功能特性

• 24 个手动构建的工具，涵盖集合、UI 模式、桌面路由、流程模型和 JS 区块

• 动态工具，根据您的 NocoBase OpenAPI/Swagger 规范自动生成（需要 API 文档插件）

• 适用于 NocoBase v2.x（已在 2.0.17-full 上测试）

要求

• Node.js 18+

• 正在运行的 NocoBase 实例

• NocoBase API 令牌（root 或具有足够权限）

安装

1. 克隆并安装依赖

git clone https://github.com/your-username/nocobase-mcp-server.git
cd nocobase-mcp-server
pnpm install

2. 配置 Claude Code（或任何 MCP 客户端）

添加到 ~/.claude/mcp.json（Claude Code 全局 MCP 配置）：

{
  "mcpServers": {
    "nocobase": {
      "type": "stdio",
      "command": "/absolute/path/to/nocobase-mcp-server/node_modules/.bin/tsx",
      "args": ["/absolute/path/to/nocobase-mcp-server/src/index.ts"],
      "env": {
        "NOCOBASE_URL": "http://localhost:13000",
        "NOCOBASE_API_TOKEN": "your-api-token-here"
      }
    }
  }
}

将 /absolute/path/to/nocobase-mcp-server 替换为您克隆仓库的实际路径（例如 /Users/yourname/Projects/nocobase-mcp-server）。

环境变量

获取 API 令牌

1. 在 NocoBase UI 中：设置 → 插件 → 启用 API keys 插件

2. 前往 设置 → API keys → 添加 API key

3. 复制生成的令牌

启用动态工具（可选）

在 NocoBase 中启用 API 文档 插件（设置 → 插件）。一旦激活，服务器将在启动时自动加载所有额外的 API 端点作为工具。

工具参考

集合

UI 模式（经典页面）

桌面路由 / 导航

流程模型 (flowPage 区块)

JS 区块

⚠️ 破坏性操作无法撤销。

JS 区块沙盒

flowPage JS 区块在 NocoBase 的沙盒中运行。可用 API：

// Render HTML
ctx.render(`<h1>Hello</h1>`);

// Render JSX with React + Ant Design
const { React, antd } = ctx.libs;
const { useState } = React;
const { Table, Tag } = antd;

function MyComponent() {
  const [tab, setTab] = useState('a');
  return <div>...</div>;
}

ctx.render(<MyComponent />);

贡献

欢迎贡献！要添加新工具：

1. Fork 本仓库并创建一个功能分支

2. 使用 server.registerTool() 在 src/index.ts 中添加您的工具

3. 遵循现有模式 — 使用 nocoFetch() 进行 API 调用，并使用 ok() 格式化响应

4. 更新 README.md 中的工具列表

5. 提交 Pull Request

如有错误报告或功能请求，请在 GitHub 上提交 Issue。

许可证

MIT — 详情请参阅 LICENSE。