Site MCP servers

Configure external MCP servers used by your site.

Manage Model Context Protocol (Mcp) servers used by your site.

The SiteMcpServer object

Attributes

objectstring · enumRequiredPossible values:

idstringRequired

Unique identifier for the MCP server

namestring · min: 1 · max: 100Required

Name of the MCP server

urlstring · uri · max: 2048Required

conditionstring · max: 1024Optional

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

The SiteMcpServer object

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

List all MCP servers for a site

get

Authorizations

user

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

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

OK

application/json

countnumberOptional

Total count of objects in the list

get

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

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/sites/{siteId}/mcp-servers HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "site-mcp-server",
      "id": "text",
      "name": "text",
      "url": "https://example.com",
      "headers": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "condition": "text",
      "urls": {
        "location": "https://example.com"
      }
    }
  ]
}

Create a new MCP server

post

Authorizations

user

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

conditionone ofOptional

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.

string · max: 1024Optional

Expression to evaluate

or

nullOptional

Responses

201

MCP server created

application/json

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: 107

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

201

MCP server created

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

Get a site MCP server

get

Authorizations

user

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

siteMcpServerIdstringRequired

The unique id of the MCP server

Responses

200

OK

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

conditionstring · max: 1024Optional

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

get

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

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/sites/{siteId}/mcp-servers/{siteMcpServerId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

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

Delete a site MCP server

delete

Authorizations

user

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

siteMcpServerIdstringRequired

The unique id of the MCP server

Responses

204

MCP server did not exist

205

MCP server deleted

delete

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

HTTPcURLJavaScriptPython

DELETE /v1/orgs/{organizationId}/sites/{siteId}/mcp-servers/{siteMcpServerId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a site MCP server

patch

Authorizations

user

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

siteMcpServerIdstringRequired

The unique id of the MCP server

Body

application/json

namestring · min: 1 · max: 100Optional

Name of the MCP server

urlstring · uri · max: 2048Optional

conditionone ofOptional

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

string · max: 1024Optional

Expression to evaluate

or

nullOptional

Responses

200

OK

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

conditionstring · max: 1024Optional

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

patch

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

HTTPcURLJavaScriptPython

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

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

200

OK

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