Skip to main content
Glama

get_doc

Get a full BitPal documentation page as Markdown. Pages: ai, api, errors, flows, lifecycle, links, overview, quickstart, reference, sdk, webhooks, x402.

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": {
      "page": "<page>"
    },
    "name": "get_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden; it does disclose that the response is Markdown and that the whole page is returned (a useful signal about response size), and 'Get' implies a read-only operation. It says nothing about authentication, rate limits, or whether content is versioned/static, so a meaningful portion of the burden is unmet.

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

Conciseness4/5

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

Two sentences, purpose front-loaded, no filler. The second sentence duplicates the schema enum word-for-word, which is mild redundancy but aids scannability for an agent skimming tool descriptions.

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?

For a single-parameter read tool with no output schema and no annotations, the definition covers what it returns, the format, and the full value space. The main remaining gap is routing guidance toward search_docs or the specific getters when a whole page is overkill.

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

Parameters3/5

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

Schema coverage is 0%, but the single parameter is a closed enum whose values are self-explanatory; the description restates that enum verbatim under 'Pages:' rather than explaining what each page contains or how to choose between them. It confirms the parameter selects a documentation page but adds no selection guidance beyond the bare value list.

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?

States a specific verb and resource ('Get a full BitPal documentation page') plus the return format (Markdown), and the word 'full' implicitly separates it from the granular sibling getters like get_api_operation and get_error_code. It stops short of naming an alternative, so the differentiation is inferred rather than stated.

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?

The enumerated page list conveys the topical scope, which implies when the tool is useful (broad reference material rather than a single operation or error code). There is no explicit 'use this when' clause, no exclusions, and no pointer to search_docs or the narrower getters for targeted lookups.

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