Skip to main content
Glama

get_doc

Read-onlyIdempotent

Fetches a Source 2 community documentation page as Markdown, returning its URL and license for citation.

Instructions

Get a community documentation page (source2.wiki) as Markdown, with its URL and license for citation.

Input Schema

NameRequiredDescriptionDefault
keyYesDoc key from search_docs (e.g. 's2wiki:/Basics') or URL

Output Schema

NameRequiredDescriptionDefault
keyYes
urlYes
bodyNo
gameNo
titleYes
sourceYes
licenseNo
descriptionNo

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?

Annotations already declare readOnlyHint, idempotentHint, and openWorldHint=false, so the safety profile is covered. The description adds useful return context (Markdown body, URL, license for citation) that the annotations can't express, but says nothing about failure behavior for an unknown or malformed key.

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 tightly packed sentence with zero filler, leading with the action and resource and closing with the citation-relevant returns. Nothing is redundant with the title or schema.

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?

With an output schema present, the description does not need to explain return values, and it still notes the Markdown format and license. For a one-parameter read tool this is nearly complete; only the error path for an invalid key is unaddressed.

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?

Only one parameter at 100% schema coverage, so the schema already explains 'key' and even gives an example format ('s2wiki:/Basics'). The description adds no syntax or format detail beyond that, so baseline 3 applies.

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 community documentation page (source2.wiki)') plus the output medium (Markdown) and what accompanies it (URL and license). This implicitly separates it from search_docs and list_docs, though it never names those siblings to make the distinction explicit.

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?

There is no explicit when-to-use or when-not-to-use guidance, and no alternative tool is named. Usage is only implied by the schema note that 'key' comes from search_docs, which suggests this is a follow-up fetch step rather than a discovery tool.

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