Skip to main content

Get Tool Usage

Immutable Catalog Entry

This descriptor comes from the active versioned Portal catalog.

READwave.wave_get_tool_usage
  • Contract tier: legacy
  • Risk: read
  • Catalog version: 2026-07-12.1
  • Descriptor hash: 2eeccc04460267a6e1e4662c19023ae70ff6f458da401b6b8e0503b3e4285142

Explain when to use a Wave MCP tool, required parameters, side effects, and follow-up tools.

Request Body

{
"jsonrpc": "2.0",
"id": "wave-wave-get-tool-usage-example",
"method": "tools/call",
"params": {
"name": "wave.wave_get_tool_usage",
"arguments": {
"toolName": "toolName_example"
}
}
}

Arguments Schema

{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"toolName"
],
"properties": {
"toolName": {
"type": "string",
"description": "Exact Wave MCP tool name to explain."
}
},
"additionalProperties": false
}

Output Schema

{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"ok",
"data",
"error",
"meta"
],
"properties": {
"ok": {
"type": "boolean",
"description": "Whether the Wave MCP operation completed successfully."
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"description": "Tool-specific Wave, Matrix, Synapse, or local navigation result."
},
"meta": {
"type": "object",
"description": "Safe execution and actor metadata without credential values.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"error": {
"anyOf": [
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"description": "Stable machine-readable error classification."
},
"details": {
"description": "Optional safe error context without credentials or request bodies."
},
"message": {
"type": "string",
"description": "Safe actionable error message."
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "Safe error details when ok is false."
}
},
"additionalProperties": false
}

Code Examples

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

Example Responses

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