Skip to main content
Glama

get_api_operation

Get one BitPal REST API operation from the OpenAPI spec: parameters, request body schema, responses and errors ($refs expanded). Path may use placeholders ({id}) or real ids.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "method": "<method>",
      "path": "<path>"
    },
    "name": "get_api_operation"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYese.g. /v1/checkout/sessions or /v1/checkout/sessions/{id}/deposit-address
methodYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations exist, so the description carries the full burden. It does disclose return content and that $refs are expanded, which is genuinely useful behavior beyond the schema, but it says nothing about what happens on an unknown path/method, whether results are cached, or whether this covers only BitPal's own spec.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, front-loaded with the action and resource, then the return payload and the path-format caveat. No filler or redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema and no annotations, the description must explain what comes back, and it does — parameters, request body schema, responses and errors with expanded $refs. What remains unstated is failure behavior for an invalid path/method, a minor gap for a simple two-parameter read tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is only 50%: path has an example but the method enum has no description. The description compensates by clarifying that path accepts both placeholder form ({id}) and real ids, which the schema does not state. Method semantics are covered by the enum itself.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: 'Get one BitPal REST API operation from the OpenAPI spec,' and then enumerates what is returned (parameters, request body schema, responses and errors). The singular 'one' implicitly separates it from the sibling list_api_operations, but no sibling is named explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is only implied: the agent can infer this is the lookup-by-endpoint tool versus search_docs or get_doc, but the description never states when to prefer it or when to use an alternative. There are no prerequisites or exclusions mentioned.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources