API Reference

MCP

Endpoints for managing MCP servers and related configuration.

Related In Learn

Actions

Connect your agents to external tools, APIs, and other agents so they can take real actions.

Open Learn

MCP endpoints manage MCP servers and related configuration.

Endpoints

GET /studio/mcp/list?pickaxeId=<pickaxe_id>

List available MCP servers and MCP servers attached to a Pickaxe.

Full URL: https://api.pickaxe.co/v1/studio/mcp/list?pickaxeId=<pickaxe_id>

Request Fields

pickaxeId (string, required): The Pickaxe ID to inspect for currently attached and available MCP servers.

Examples

curl -X GET "https://api.pickaxe.co/v1/studio/mcp/list?pickaxeId=steve-25" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"

Response Shape

{
  "success": true,
  "data": {
    "available": [
      {
        "serverId": "mcp-f81dddb7-3547-4d3b-b439-ab803f995c61",
        "name": "OpenAIWebSearch",
        "description": "",
        "visibility": "public",
        "serverHost": "uvx pickaxe-mcp-web-search",
        "tools": [
          {
            "name": "search",
            "description": "Perform a web search for the given query.",
            "required": ["query"]
          }
        ],
        "isAttached": false,
        "env": {}
      }
    ],
    "attached": [],
    "pickaxeId": "steve-25"
  }
}

POST /studio/mcp/connect

Attach an MCP server to a Pickaxe.

Full URL: https://api.pickaxe.co/v1/studio/mcp/connect

Request Fields

pickaxeId (string, required): The Pickaxe ID to attach the MCP server to.
serverId (string, required): The MCP server ID to attach.

Examples

curl -X POST https://api.pickaxe.co/v1/studio/mcp/connect \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
  "pickaxeId": "steve-25",
  "serverId": "mcp-f81dddb7-3547-4d3b-b439-ab803f995c61"
}'

Response Shape

{
  "serverId": "mcp-f81dddb7-3547-4d3b-b439-ab803f995c61",
  "name": "OpenAIWebSearch",
  "description": "",
  "visibility": "public",
  "serverHost": "uvx pickaxe-mcp-web-search",
  "tools": [
    {
      "name": "search",
      "description": "Perform a web search for the given query.",
      "required": ["query"]
    }
  ],
  "isAttached": true,
  "env": {}
}

POST /studio/mcp/disconnect

Remove an MCP server from a Pickaxe.

Full URL: https://api.pickaxe.co/v1/studio/mcp/disconnect

Request Fields

pickaxeId (string, required): The Pickaxe ID to disconnect the MCP server from.
serverId (string, required): The MCP server ID to disconnect.

Examples

curl -X POST https://api.pickaxe.co/v1/studio/mcp/disconnect \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
  "pickaxeId": "steve-25",
  "serverId": "mcp-f81dddb7-3547-4d3b-b439-ab803f995c61"
}'

Response Shape

{
  "pickaxeId": "steve-25",
  "serverId": "mcp-f81dddb7-3547-4d3b-b439-ab803f995c61"
}

Action

Document