Skip to main content
Glama

Install docset

install_docset

Download a documentation set into the local cache for offline use, re-downloading only if the upstream version is newer.

Instructions

Download a DevDocs docset into the local cache (re-downloads only if upstream is newer).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesDocset slug, e.g. 'vite'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full behavioral burden. It does disclose the specific behavior 're-downloads only if upstream is newer' and the action 'Download', but it omits details about potential side effects such as overwriting existing cache entries or network requirements.

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?

A single well-written sentence covers the action, the target, and the key idempotency behavior. No unnecessary words or redundant information are included, and the main verb is appropriately front-loaded.

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 tool with only one parameter, no output schema, and no annotations, the description covers the essential context:, the command, what gets downloaded, where it goes, and the caching update policy. It is missing potential edge-case details like error handling, but those are not required for correct invocation.

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?

The parameter `slug` is already fully documented in the schema with a definition and example ('Docset slug, e.g. 'vite''), achieving 100% schema coverage. The description adds no additional information about the parameter's meaning or syntax beyond that baseline.

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 clearly identifies the verb ('Download'), resource ('DevDocs docset'), and target ('local cache'). This distinguishes it from siblings like remove_docset and list_docsets, which handle deletion and listing, respectively.

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 does not explicitly say when to use this tool versus alternatives or when not to use it. While its purpose implies its use for installing docsets, no direct guidance or written mention of alternatives exists.

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

Deploy Server

Other Tools