nocobase-mcp-server

Un servidor MCP (Model Context Protocol) para NocoBase, que permite a asistentes de IA como Claude interactuar con tu instancia de NocoBase: leer colecciones, gestionar esquemas de interfaz de usuario, crear bloques flowPage y ejecutar operaciones de API dinámicas a través de OpenAPI.

Características

• 24 herramientas creadas manualmente que cubren colecciones, esquemas de interfaz de usuario, rutas de escritorio, modelos de flujo y bloques JS

• Herramientas dinámicas generadas automáticamente a partir de la especificación OpenAPI/Swagger de tu NocoBase (requiere el plugin de documentación de API)

• Funciona con NocoBase v2.x (probado en 2.0.17-full)

Requisitos

• Node.js 18+

• Una instancia de NocoBase en ejecución

• Un token de API de NocoBase (root o con permisos suficientes)

Instalación

1. Clonar e instalar dependencias

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

2. Configurar Claude Code (o cualquier cliente MCP)

Añadir a ~/.claude/mcp.json (configuración global de MCP de 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"
      }
    }
  }
}

Reemplaza /absolute/path/to/nocobase-mcp-server con la ruta real donde clonaste el repositorio (por ejemplo, /Users/tu-nombre/Projects/nocobase-mcp-server).

Variables de entorno

Obtención de un token de API

1. En la interfaz de usuario de NocoBase: Configuración → Plugins → activa el plugin API keys

2. Ve a Configuración → API keys → Añadir API key

3. Copia el token generado

Habilitación de herramientas dinámicas (opcional)

Activa el plugin API documentation en NocoBase (Configuración → Plugins). Una vez activo, el servidor cargará automáticamente todos los endpoints de API adicionales como herramientas al iniciarse.

Referencia de herramientas

Colecciones

Esquemas de interfaz de usuario (Páginas clásicas)

Rutas de escritorio / Navegación

Modelos de flujo (bloques flowPage)

Bloques JS

⚠️ Las operaciones destructivas no se pueden deshacer.

Sandbox de bloques JS

Los bloques JS de flowPage se ejecutan en el sandbox de NocoBase. APIs disponibles:

// 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 />);

Contribución

¡Las contribuciones son bienvenidas! Para añadir una nueva herramienta:

1. Haz un fork del repositorio y crea una rama de funcionalidad

2. Añade tu herramienta en src/index.ts usando server.registerTool()

3. Sigue el patrón existente: usa nocoFetch() para llamadas a la API y ok() para formatear las respuestas

4. Actualiza la lista de herramientas en README.md

5. Abre una solicitud de extracción (pull request)

Para informes de errores o solicitudes de funciones, abre un issue en GitHub.

Licencia

MIT — consulta LICENSE para más detalles.