Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Get Mcp Server

GET/api/v2/ontologyMcp/mcpServers/{mcpServerRid}
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Get details of an MCP server.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:ontology-mcp-read.

Path parameters

mcpServerRid
string

The RID of the MCP server.

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Response body

McpServer
object
Hide child attributes

Hide child attributes

rid
string

The RID of the MCP server.

name
string

The display name of the MCP server.

description
string

An LLM-oriented description of the MCP server.

Examples

Request

Copied!
1 2 3 curl \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/ontologyMcp/mcpServers/ri.third-party-applications.main.application.a1b2c3d4-e5f6-7890-abcd-ef1234567890?preview=true"

Response

Copied!
1 2 3 4 5 { "name": "My MCP Server", "description": "An MCP server that provides access to custom tools.", "rid": "ri.third-party-applications.main.application.a1b2c3d4-e5f6-7890-abcd-ef1234567890" }

Error responses

Error Name
McpServerNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given McpServer could not be found.
ParametersmcpServerRid