Add a new MCP server configuration to a site

Registers a new Model Context Protocol (MCP) server with the site, providing its URL, transport type, request headers, and an optional conditional expression to control visibility per visitor. Once added, the MCP server's tools become available to the AI Assistant when helping visitors of this site.

Available in MCP

post

Authorizations

useroauth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

siteIdstringRequired

The unique id of the site

Body

application/json

namestring · min: 1 · max: 100Required

Name of the MCP server

urlstring · uri · max: 2048Required

transportstring · enumOptional

Transport protocol used to connect to the MCP server

Default: ssePossible values:

conditionstring · max: 1024 · nullableOptional

Conditional expression used to evaluate whether the MCP server should be available to the site's visitor (should evaluate to a boolean). If set to null, the condition will be removed.

Responses

201

MCP server created

application/json

objectstring · enumRequiredPossible values:

idstringRequired

Unique identifier for the MCP server

namestring · min: 1 · max: 100Required

Name of the MCP server

urlstring · uri · max: 2048Required

transportstring · enumRequired

Transport protocol used to connect to the MCP server

Default: ssePossible values:

conditionstring · max: 1024Optional

Conditional expression used to evaluate whether the MCP server should be available to the site's visitor.

post/orgs/{organizationId}/sites/{siteId}/mcp-servers

HTTPcURLJavaScriptPython

POST /v1/orgs/{organizationId}/sites/{siteId}/mcp-servers HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "name": "text",
  "url": "https://example.com",
  "transport": "sse",
  "headers": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "condition": "text"
}

201

MCP server created

{
  "object": "site-mcp-server",
  "id": "text",
  "name": "text",
  "url": "https://example.com",
  "transport": "sse",
  "headers": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "condition": "text",
  "urls": {
    "location": "https://example.com"
  }
}