nocobase-mcp-server

MCP-сервер (Model Context Protocol) для NocoBase, позволяющий ИИ-ассистентам, таким как Claude, взаимодействовать с вашим экземпляром NocoBase — читать коллекции, управлять схемами UI, создавать блоки flowPage и выполнять динамические операции API через OpenAPI.

Возможности

• 24 инструмента, созданных вручную, охватывающих коллекции, схемы UI, маршруты рабочего стола, модели потоков и JS-блоки

• Динамические инструменты, автоматически генерируемые из спецификации OpenAPI/Swagger вашего NocoBase (требуется плагин API documentation)

• Работает с NocoBase v2.x (протестировано на 2.0.17-full)

Требования

• Node.js 18+

• Запущенный экземпляр NocoBase

• API-токен NocoBase (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 (глобальный конфиг MCP для Claude Code):

{
  "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: Settings → Plugins → включите плагин API keys

2. Перейдите в Settings → API keys → Add API key

3. Скопируйте сгенерированный токен

Включение динамических инструментов (опционально)

Включите плагин API documentation в NocoBase (Settings → Plugins). После активации сервер будет автоматически загружать все дополнительные API-эндпоинты в качестве инструментов при запуске.

Справочник инструментов

Коллекции

Схемы UI (Классические страницы)

Маршруты рабочего стола / Навигация

Модели потоков (блоки flowPage)

JS-блоки

⚠️ Деструктивные операции нельзя отменить.

Песочница JS-блоков

JS-блоки flowPage запускаются в песочнице 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. Сделайте форк репозитория и создайте ветку для новой функции

2. Добавьте свой инструмент в src/index.ts, используя server.registerTool()

3. Следуйте существующему шаблону — используйте nocoFetch() для вызовов API и ok() для форматирования ответов

4. Обновите список инструментов в README.md

5. Откройте pull request

Для сообщений об ошибках или предложений по новым функциям создайте issue на GitHub.

Лицензия

MIT — подробности см. в LICENSE.