Get Tool Reference

Immutable Catalog Entry

This descriptor comes from the active versioned Portal catalog.

READportal.get_tool_reference

• Contract tier: agent_ready
• Risk: read
• Catalog version: portal-agent-contract-v2-2026.07.12.1
• Descriptor hash: 7bb8c7c770352cd0ea093baafef4286aa73ee8e6c86989fb9e67f07d17fdb3f7

Return one lossless descriptor with schemas, safety rules, and hash.

Request Body

{
  "jsonrpc": "2.0",
  "id": "portal-get-tool-reference-example",
  "method": "tools/call",
  "params": {
    "name": "portal.get_tool_reference",
    "arguments": {
      "toolName": "toolName_example",
      "serviceId": "serviceId_123",
      "includeLegacy": false
    }
  }
}

Arguments Schema

{
  "type": "object",
  "required": [
    "toolName"
  ],
  "properties": {
    "toolName": {
      "type": "string",
      "description": "Native, alias, or service.toolName identity."
    },
    "serviceId": {
      "type": "string",
      "description": "Service id when toolName is not namespaced."
    },
    "includeLegacy": {
      "type": "boolean",
      "description": "Advanced/admin clients only."
    }
  },
  "additionalProperties": false
}

Output Schema

{
  "type": "object",
  "required": [
    "ok",
    "serviceId",
    "toolName",
    "traceId",
    "summary",
    "data",
    "resource",
    "pagination",
    "nextAction",
    "error"
  ],
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "data": {
      "description": "Tool result."
    },
    "error": {
      "type": [
        "object",
        "null"
      ]
    },
    "summary": {
      "type": "string"
    },
    "traceId": {
      "type": "string"
    },
    "resource": {
      "type": [
        "object",
        "null"
      ]
    },
    "toolName": {
      "type": "string"
    },
    "serviceId": {
      "type": "string"
    },
    "nextAction": {
      "type": [
        "string",
        "null"
      ]
    },
    "pagination": {
      "type": [
        "object",
        "null"
      ]
    }
  },
  "additionalProperties": false
}

Code Examples

cURL

curl -X POST 'https://portal.madpanda3d.com/api/mcp' \
  -H 'Authorization: Bearer mad_live_***' \
  -H 'Content-Type: application/json' \
  -d '{
  "jsonrpc": "2.0",
  "id": "portal-get-tool-reference-example",
  "method": "tools/call",
  "params": {
    "name": "portal.get_tool_reference",
    "arguments": {
      "toolName": "toolName_example",
      "serviceId": "serviceId_123",
      "includeLegacy": false
    }
  }
}'

Node.js

const response = await fetch('https://portal.madpanda3d.com/api/mcp', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer mad_live_***',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "jsonrpc": "2.0",
  "id": "portal-get-tool-reference-example",
  "method": "tools/call",
  "params": {
    "name": "portal.get_tool_reference",
    "arguments": {
      "toolName": "toolName_example",
      "serviceId": "serviceId_123",
      "includeLegacy": false
    }
  }
}),
});
const data = await response.json();
console.log(data);

Python

import requests

url = 'https://portal.madpanda3d.com/api/mcp'
headers = {
    'Authorization': 'Bearer mad_live_***',
    'Content-Type': 'application/json',
}
payload = {
  "jsonrpc": "2.0",
  "id": "portal-get-tool-reference-example",
  "method": "tools/call",
  "params": {
    "name": "portal.get_tool_reference",
    "arguments": {
      "toolName": "toolName_example",
      "serviceId": "serviceId_123",
      "includeLegacy": false
    }
  }
}
response = requests.post(url, headers=headers, json=payload, timeout=60)
print(response.json())

Example Responses

200 Success

{
  "ok": true,
  "message": "Tool portal.get_tool_reference executed successfully.",
  "note": "Response shape varies by MCP tool. Inspect live responses for exact fields."
}

502 Upstream Error

{
  "ok": false,
  "classification": "upstream_http_error",
  "message": "Upstream MCP returned a non-success status."
}