← Documentation home
POST/hyax-api/mcp

List MCP tools

Returns all tools exposed by the Hyax MCP server. Each tool has a name, description, and JSON Schema inputSchema. Tool results are JSON strings in the content array.

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Request examples

Same request in cURL, Node.js (fetch), and PHP (ext-curl).

curl -X POST 'https://platform.hyax.com/hyax-api/mcp' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "jsonrpc": "2.0",
    "id": 2,
    "method": "tools/list",
    "params": {}
  }'

Example response

Shape varies by data; values are illustrative.

{
  "jsonrpc": "2.0",
  "id": 2,
  "result": {
    "tools": [
      {
        "name": "posts_list",
        "description": "List posts for the team. Filter by status, postType, or search query.",
        "inputSchema": {
          "type": "object",
          "properties": {
            "page": { "type": "number", "description": "Page number (default: 1)" },
            "limit": { "type": "number", "description": "Results per page (default: 20)" },
            "status": { "type": "string", "enum": ["DRAFT", "SCHEDULED", "PUBLISHED", "ARCHIVED"] },
            "search": { "type": "string" }
          }
        }
      },
      {
        "name": "people_add",
        "description": "Add a new person to the CRM.",
        "inputSchema": {
          "type": "object",
          "properties": {
            "email": { "type": "string" },
            "name": { "type": "string" },
            "tags": { "type": "array", "items": { "type": "string" } }
          },
          "required": ["email"]
        }
      }
    ]
  }
}