Explore how adaptive content transforms your docs into a dynamic, tailored experience for every user.
Read the docs
PricingLog inSign up

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

The SiteMcpServer object

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

List all MCP servers for a site

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

The unique id of the organization

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
Responseall of
get
/orgs/{organizationId}/sites/{siteId}/mcp-servers
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"
      },
      "urls": {
        "location": "https://example.com"
      }
    }
  ]
}

Create a new MCP server

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

Body
namestring · min: 1 · max: 100Required

Name of the MCP server

urlstring · uri · max: 2048Required
Responses
post
/orgs/{organizationId}/sites/{siteId}/mcp-servers
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: 88

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

MCP server created

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

Get a site MCP server

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

siteMcpServerIdstringRequired

The unique id of the MCP server

Responses
200

OK

application/json
get
/orgs/{organizationId}/sites/{siteId}/mcp-servers/{siteMcpServerId}
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"
  },
  "urls": {
    "location": "https://example.com"
  }
}

Delete a site MCP server

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

siteMcpServerIdstringRequired

The unique id of the MCP server

Responses
delete
/orgs/{organizationId}/sites/{siteId}/mcp-servers/{siteMcpServerId}
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
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

siteMcpServerIdstringRequired

The unique id of the MCP server

Body
namestring · min: 1 · max: 100Optional

Name of the MCP server

urlstring · uri · max: 2048Optional
Responses
200

OK

application/json
patch
/orgs/{organizationId}/sites/{siteId}/mcp-servers/{siteMcpServerId}
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: 88

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

OK

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

Last updated

Was this helpful?