Connectors

Connectors

get

Get information about available modules and their routes.

Args: modules (List[str], optional): List of module names to get routes for. If not provided, all available modules will be used.

Returns: Dict[str, Dict[str, Any]]: Dictionary of module names and their routes.

Query parameters
modulesstring[]OptionalDefault: []
Responses
chevron-right
200

Successful Response

application/json
Responseany
get
/connectors

No content

Plugin Names

get

Get list of available plugin names.

Returns: List[str]: Array of plugin names.

Responses
chevron-right
200

Successful Response

application/json
Responseany
get
/connectors/names
200

Successful Response

No content

Get Mcp Categories

get

Returns all possible categories.

Returns: dict[str, str]: Key-Value pair of the Category's Name and its Value.

Responses
chevron-right
200

Successful Response

application/json
get
/mcps/categories
200

Successful Response

Get Mcps

get

List all registered MCP connectors with metadata.

Args: request (Request): Incoming HTTP request, used for URL construction.

Returns: ListResponse[MCPDetailResponse, MCPListMeta]: Structured list of MCP connector details and meta counts.

Responses
chevron-right
200

Successful Response

application/json
get
/mcps
200

Successful Response

Get External Mcps

get

List all external MCP connectors with metadata.

Args: request (Request): Incoming HTTP request, used for URL construction. force_new (bool): Whether or not to recache a new set of external MCPs.

Returns: ListResponse[MCPDetailResponse, MCPListMeta]: Structured list of external MCP connector details and meta counts.

Query parameters
force_newbooleanOptional

Whether or not to recache a new set of external MCPs

Default: false
Responses
chevron-right
200

Successful Response

application/json
get
/mcps/external

Get Mcp List Page

get

Render a web page listing all MCP connectors with filtering and categorization.

Args: request (Request): Incoming HTTP request, used for URL construction and template rendering. force_new (bool): Whether or not to recache a new set of external MCPs.

Returns: TemplateResponse: HTML page with MCP connectors organized by category.

Query parameters
force_newbooleanOptional

Whether or not to recache a new set of external MCPs

Default: false
Responses
chevron-right
200

Successful Response

application/json
Responseany
get
/mcps/list

No content

Mcp Oembed

get

Return oEmbed metadata for the MCP list page.

This endpoint follows the oEmbed specification (https://oembed.com/) and is used by GitBook and other platforms to embed the MCP list page.

Args: request (Request): Incoming HTTP request, used for URL construction. url (str | None, optional): The URL of the resource being embedded. Defaults to None. format (str | None, optional): The response format (json or xml). Defaults to json. maxwidth (int | None, optional): Maximum width for the embed. Defaults to None. maxheight (int | None, optional): Maximum height for the embed. Defaults to None.

Returns: JSONResponse: oEmbed response payload for GitBook and other consumers.

Query parameters
urlany ofOptional
stringOptional
or
nullOptional
formatany ofOptionalDefault: json
stringOptional
or
nullOptional
maxwidthany ofOptional
integerOptional
or
nullOptional
maxheightany ofOptional
integerOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany
get
/mcps/oembed

No content

Last updated

Was this helpful?