Skip to main content
Glama

resolve_docs

Read-only

Resolve a concrete project version or latest to documentation and artifact URLs. Discover valid version strings with list_versions first. Save resolved_version and, when present, revision_id. Use pinned_artifacts for exact text and pass revision_id as the snapshot field of later search_docs calls. Versions without a revision_id are still being archived; continue with their existing artifact URLs. Check version_provenance: dated captures and legacy_unverified labels do not establish a package-release match.

Input Schema

NameRequiredDescriptionDefault
projectYesProject slug (e.g. "nextjs", "react")
versionYesVersion string or "latest"

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

The annotations already declare a read-only, open-world operation, and the description adds useful behavior beyond that: how to save `resolved_version` and `revision_id`, how to use `pinned_artifacts`, and how to interpret `version_provenance` labels. It does not describe pagination or error behavior, but for a resolution tool the main behavioral caveats are well covered.

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?

The purpose is front-loaded in the first sentence, and the remaining sentences contain actionable guidance rather than filler. It is dense with field names and caveats, but the density earns its place in a compact tool definition.

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

Completeness5/5

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

There is no output schema, so the description carries the return-value burden, and it does so by naming `resolved_version`, `revision_id`, artifact URLs, `pinned_artifacts`, and `version_provenance`. For a two-parameter resolution tool, this is complete enough for an agent to call and interpret results correctly.

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 100%, so both parameters are already documented in the schema. The description still adds meaningful semantics for `version` by accepting `latest` and by directing discovery through `list_versions`, which goes beyond what the schema states.

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

Purpose5/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: resolving a project version or `latest` to documentation and artifact URLs. It clearly distinguishes this from siblings by referring to `list_versions` for discovery and `search_docs` for later use, so an agent can identify the tool without opening the schema.

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

Usage Guidelines5/5

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

It explicitly says to discover valid version strings with `list_versions` first, and it routes later exact-text lookups to `pinned_artifacts` and `search_docs` via `revision_id`. It also handles the important edge case of versions without a `revision_id`, telling the agent to continue with existing artifact URLs.

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.