Skip to main content
Glama

docs

Browse a package documentation module listing

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesPackage name on hex.pm
versionNoPackage version (defaults to latest)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.5/5.0
Behavior2/5

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

With no annotations at all, the description carries the full burden of behavioral disclosure and does not meet it. It says nothing about whether the result is paginated, how large a listing may be, whether a non-existent package errors, or what the response shape is.

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

Conciseness3/5

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

A single short phrase with no waste, but it is concise through under-specification rather than disciplined front-loading. There is no structure to speak of — just a noun phrase.

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

Completeness2/5

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

With no annotations and no output schema, the description is the only source of behavioral and usage context, and it is inadequate for a tool sitting among ~23 doc-related siblings. An agent cannot reliably tell when this tool applies or what it returns.

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 100%, so both parameters ('name' and 'version') are already fully documented in the schema, including the 'defaults to latest' behavior. The description adds nothing beyond that, which merits the baseline 3.

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

Purpose3/5

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

Names a verb ('Browse') and a resource ('package documentation module listing'), so the general intent is graspable, but 'documentation module listing' is ambiguous — it is unclear whether this returns a list of modules, a module's contents, or a rendered doc page. It does not distinguish itself from close siblings like doc_item, search_docs, or readme.

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

Usage Guidelines2/5

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

The description offers no guidance on when to use this tool versus the many adjacent doc-related siblings (doc_item, search_docs, readme). No prerequisites, no exclusions, no indication of what makes this the right choice.

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.