nocobase-mcp-server

Ein MCP-Server (Model Context Protocol) für NocoBase, der es KI-Assistenten wie Claude ermöglicht, mit Ihrer NocoBase-Instanz zu interagieren — Sammlungen lesen, UI-Schemas verwalten, flowPage-Blöcke erstellen und dynamische API-Operationen über OpenAPI ausführen.

Funktionen

• 24 manuell erstellte Tools für Sammlungen, UI-Schemas, Desktop-Routen, Flow-Modelle und JS-Blöcke

• Dynamische Tools, die automatisch aus der OpenAPI/Swagger-Spezifikation Ihres NocoBase generiert werden (erfordert das API-Dokumentations-Plugin)

• Funktioniert mit NocoBase v2.x (getestet mit 2.0.17-full)

Anforderungen

• Node.js 18+

• Eine laufende NocoBase-Instanz

• Ein NocoBase-API-Token (Root oder ausreichende Berechtigungen)

Installation

1. Klonen und Abhängigkeiten installieren

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

2. Claude Code (oder einen beliebigen MCP-Client) konfigurieren

Fügen Sie dies zu ~/.claude/mcp.json hinzu (globale MCP-Konfiguration von 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"
      }
    }
  }
}

Ersetzen Sie /absolute/path/to/nocobase-mcp-server durch den tatsächlichen Pfad, unter dem Sie das Repository geklont haben (z. B. /Users/yourname/Projects/nocobase-mcp-server).

Umgebungsvariablen

API-Token abrufen

1. In der NocoBase-Benutzeroberfläche: Einstellungen → Plugins → das API keys-Plugin aktivieren

2. Gehen Sie zu Einstellungen → API keys → API-Schlüssel hinzufügen

3. Kopieren Sie den generierten Token

Dynamische Tools aktivieren (optional)

Aktivieren Sie das API documentation-Plugin in NocoBase (Einstellungen → Plugins). Sobald es aktiv ist, lädt der Server beim Start automatisch alle zusätzlichen API-Endpunkte als Tools.

Tool-Referenz

Sammlungen

UI-Schemas (Klassische Seiten)

Desktop-Routen / Navigation

Flow-Modelle (flowPage-Blöcke)

JS-Blöcke

⚠️ Destruktive Operationen können nicht rückgängig gemacht werden.

JS-Block-Sandbox

flowPage JS-Blöcke laufen in der Sandbox von NocoBase. Verfügbare APIs:

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

Mitwirken

Beiträge sind willkommen! Um ein neues Tool hinzuzufügen:

1. Forken Sie das Repository und erstellen Sie einen Feature-Branch

2. Fügen Sie Ihr Tool in src/index.ts mit server.registerTool() hinzu

3. Folgen Sie dem bestehenden Muster — verwenden Sie nocoFetch() für API-Aufrufe und ok() zur Formatierung der Antworten

4. Aktualisieren Sie die Tool-Liste in der README.md

5. Erstellen Sie einen Pull Request

Für Fehlerberichte oder Funktionsanfragen öffnen Sie bitte ein Issue auf GitHub.

Lizenz

MIT — siehe LICENSE für Details.