Skip to main content

Documentation Index

Fetch the complete documentation index at: https://hypha-docs.plinqx.app/llms.txt

Use this file to discover all available pages before exploring further.

The Model Context Protocol (MCP) is the primary interface for AI clients to discover and call tools in Plinqx.

​
Base URL

https://hypha-api.plinqx.app/mcp
Or your custom domain if configured.

​
Authentication

Authenticate using API key: 
Authorization: Bearer plinqx_xxxxxxxxxxxxxxxxxxxx
Or as query parameter: 
?api_key=plinqx_xxxxxxxxxxxxxxxxxxxx

​
Endpoints

​
List Tools

GET /mcp/tools Returns all tools available to the authenticated API key’s Collections. See Tools List for details.

​
Call Tool

POST /mcp/tools/:name Executes a tool with provided arguments. See Tools Call for details.

​
JSON-RPC Support

Plinqx also supports JSON-RPC 2.0: POST /mcp/rpc Use JSON-RPC for clients that prefer RPC-style communication.

​
Response Format

All MCP endpoints return JSON: 
{
  "tools": [...],
  "result": {...},
  "error": {...}
}

​
Rate Limiting

Rate limits apply per API key:
  • Default: Varies by plan
  • Per-Collection: Configurable via policies
  • Headers: Rate limit info in response headers

​
Error Handling

Errors follow MCP protocol format: 
{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message"
  }
}

​
Next Steps

Tools List

Learn about the tools list endpoint

Tools Call

Learn about tool execution