#NocoBase MCP

Une fois le plugin de service MCP de NocoBase activé, l'application NocoBase expose une interface de service MCP, permettant à un client MCP d'accéder aux interfaces de NocoBase et de les appeler.

#Adresse du service

• Application principale :

  http(s)://<host>:<port>/api/mcp

• Sous-application :

  http(s)://<host>:<port>/api/__app/<app_name>/mcp

Cette adresse utilise le protocole de transport streamable HTTP.

#Capacités fournies

#Outils génériques

Utilisables pour manipuler les tables de données.

#Interfaces du noyau NocoBase et des plugins

Vous pouvez contrôler quels packages exposent leurs interfaces via MCP grâce à l'en-tête de requête x-mcp-packages, par exemple :

x-mcp-packages: @nocobase/server,plugin-workflow*,plugin-users

Cet en-tête accepte les noms de packages complets ; en l'absence de scope, @nocobase/ est ajouté automatiquement.

Par défaut, seuls les outils génériques sont chargés ; pour les autres fonctionnalités du système, il est recommandé d'utiliser plutôt la NocoBase CLI.

Description des packages courants :

Pour plus de packages et la description de leurs interfaces, vous pouvez consulter le plugin Documentation API.

#Méthodes d'authentification

#Authentification par API Key

Utilisez une API key créée via le plugin API keys pour appeler les interfaces du service MCP ; les permissions sont déterminées par le rôle associé à la clé.

#Authentification OAuth

Utilisez l'access token obtenu après autorisation OAuth pour appeler les interfaces du service MCP ; les permissions sont déterminées par l'utilisateur autorisé. Si l'utilisateur a plusieurs rôles, vous pouvez définir le rôle d'appel via l'en-tête de requête x-role.

#Démarrage rapide

#Codex

#Authentification par API Key

Activez d'abord le plugin API Keys et créez une API Key.

export NOCOBASE_API_TOKEN=<your_api_key>
codex mcp add nocobase --url https://<host>:<port>/api/mcp --bearer-token-env-var NOCOBASE_API_TOKEN

#Authentification OAuth

Activez d'abord le plugin IdP: OAuth.

codex mcp add nocobase --url https://<host>:<port>/api/mcp
codex mcp login nocobase --scopes mcp,offline_access

#Claude Code

#Authentification par API Key

Activez d'abord le plugin API Keys et créez une API Key.

claude mcp add --transport http nocobase https://<host>:<port>/api/mcp --header "Authorization: Bearer <your_api_key>"

#Authentification OAuth

Activez d'abord le plugin IdP: OAuth.

claude mcp add --transport http nocobase https://<host>:<port>/api/mcp

Une fois exécuté, ouvrez Claude et connectez-vous au service MCP correspondant :

claude
/mcp

#OpenCode

#Authentification par API Key

Activez d'abord le plugin API Keys et créez une API Key. Configurez opencode.json :

{
  "mcp": {
    "nocobase": {
      "type": "remote",
      "url": "https://<host>:<port>/api/mcp",
      "enabled": true,
      "headers": {
        "Authorization": "Bearer <your_api_key>"
      }
    }
  },
  "$schema": "https://opencode.ai/config.json"
}

#Authentification OAuth

Activez d'abord le plugin IdP: OAuth. Configurez opencode.json :

{
  "mcp": {
    "nocobase": {
      "type": "remote",
      "url": "https://<host>:<port>/api/mcp",
      "enabled": true
    }
  },
  "$schema": "https://opencode.ai/config.json"
}

Authentification :

opencode mcp auth nocobase

Debug :

opencode mcp debug nocobase