Skip to main content

MCP Integration

Connect AI agents to OpenDocs using the Model Context Protocol (MCP). Full support for tools, resources, and prompts.

MCP Endpoint
Connect your AI agent to this endpoint
https://docs.platphormnews.com/api/mcp
Initialize Connection
Start an MCP session
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "initialize"
}
Get Server Metadata
Public read-only metadata for MCP discovery and auth boundaries
GET /api/mcp

Response:
{
  "name": "opendocs-mcp",
  "endpoint": "https://docs.platphormnews.com/api/mcp",
  "protocol_version": "2024-11-05",
  "capabilities": {
    "tools": 53,
    "resources": 23,
    "prompts": 16
  }
}
Example: List Tools
// Request
{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/list"
}

// Response
{
  "jsonrpc": "2.0",
  "id": 2,
  "result": {
    "tools": [
      {
        "name": "list_documents",
        "description": "List all published documentation...",
        "inputSchema": { ... }
      },
      ...
    ]
  }
}
Example: Call a Tool
// Request
{
  "jsonrpc": "2.0",
  "id": 3,
  "method": "tools/call",
  "params": {
    "name": "search_docs",
    "arguments": {
      "query": "getting started",
      "limit": 5
    }
  }
}

// Response
{
  "jsonrpc": "2.0",
  "id": 3,
  "result": {
    "content": [{
      "type": "text",
      "text": "{ results: [...] }"
    }]
  }
}
Example: Preview a Public Clip
Public-safe clipping tools do not require a key and return degraded status instead of fake source content.
{
  "jsonrpc": "2.0",
  "id": 6,
  "method": "tools/call",
  "params": {
    "name": "clip_preview",
    "arguments": {
      "url": "https://example.com/public-guide"
    }
  }
}