Skip to main content
Glama

inspect_documentation

Read-onlyIdempotent

Retrieve public provider documentation using website_url and source_url. Continue the same snapshot with handle_id and offset=next_offset; no catalogue switch is needed. Returns readable text and source citations. Public access.

Input Schema

NameRequiredDescriptionDefault
limitNo
offsetNo
handle_idNo
source_urlNo
website_urlNo
association_urlNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and openWorldHint, so the safety profile is covered. The description adds value beyond that: 'Public access' signals no auth requirement, and it discloses the return shape ('readable text and source citations') plus the snapshot-continuation behavior for paging.

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?

Three tight sentences with the primary action front-loaded and no filler. The pagination instruction, arguably the most failure-prone detail, is placed early and stated in actionable form.

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

Completeness3/5

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

No output schema exists, and the description largely compensates by summarizing the return ('readable text and source citations'). Yet with 6 optional params and 0% schema coverage, it never clarifies how website_url versus source_url versus association_url relate, leaving the invocation ambiguous.

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 description coverage is 0% across 6 parameters, so the description must carry the burden. It names four (website_url, source_url, handle_id, offset) and explains how offset pairs with next_offset, but limit and association_url are undocumented anywhere, and no parameter is marked required.

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 ('Retrieve') and resource ('public provider documentation') plus the retrieval surfaces (website_url, source_url), which is clear. It does not explicitly differentiate itself from the sibling read_documentation, so an agent must infer the split.

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?

Gives real procedural guidance for pagination ('Continue the same snapshot with handle_id and offset=next_offset; no catalogue switch is needed'), which is more than implied usage. However it never says when to pick this over read_documentation or browse_catalogue, and gives no exclusions.

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