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 tools/list endpoint returns all tools available to the authenticated API key’s Collections.

​
Endpoint

GET /mcp/tools

​
Authentication

​
Authorization
string
required
Bearer token with your Plinqx API key. Format: Bearer plinqx_xxxxxxxxxxxxxxxxxxxx
Or use query parameter:
​
api_key
string
required
Your Plinqx API key

​
Request Example

curl -X GET 'https://hypha-api.plinqx.app/mcp/tools' \
  -H 'Authorization: Bearer plinqx_xxxxxxxxxxxxxxxxxxxx'

​
Response

​
tools
array
required
Array of tool definitions available to the API key.

​
Tool Object

​
name
string
required
Tool identifier (e.g., sf_query, custom__get_weather)
​
description
string
required
Human-readable description of what the tool does
​
inputSchema
object
required
JSON Schema defining the tool’s input parameters

​
Response Example

{
  "tools": [
    {
      "name": "sf_query",
      "description": "Execute a SOQL query against Salesforce",
      "inputSchema": {
        "type": "object",
        "properties": {
          "query": {
            "type": "string",
            "description": "SOQL query to execute"
          }
        },
        "required": ["query"]
      }
    },
    {
      "name": "custom__get_weather",
      "description": "Get current weather for a city",
      "inputSchema": {
        "type": "object",
        "properties": {
          "city": {
            "type": "string",
            "description": "City name"
          }
        },
        "required": ["city"]
      }
    }
  ]
}

​
Tool Filtering

Tools are filtered based on:
  • Collection Access: Only tools in API key’s Collections are returned
  • Store Exposure: Tools must be exposed to the requesting store (if store context is provided)
  • Tool Status: Only published/enabled tools are returned

​
Response Headers

​
X-RateLimit-Limit
string
Maximum requests per time window
​
X-RateLimit-Remaining
string
Remaining requests in current window
​
X-RateLimit-Reset
string
Unix timestamp when rate limit resets

​
Error Responses

​
401 Unauthorized

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or expired API key"
  }
}

​
403 Forbidden

{
  "error": {
    "code": "FORBIDDEN",
    "message": "API key does not have access to any Collections"
  }
}

​
Next Steps

Call Tools

Learn how to execute tools

Create API Keys

Generate API keys for your clients