Skip to main content
Glama

Read a Knowledge Document

worlds_get_document
Read-onlyIdempotent

Read the bounded public excerpt and metadata for one source-checked CLI manual returned by worlds_search_knowledge. Follow canonical_url for the complete manual. Structured CLI command tools remain complete.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesStable document id from a search or comparison result.
offsetNo
max_charactersNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
titleYes
worldYes
productYes
summaryYes
languageYes
reviewed_atNo
content_typeYes
published_atNo
rights_basisYes
canonical_urlYes
fixed_excerptYes
source_statusYes
official_sourcesYes
knowledge_collectionYes

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive. The description adds that the excerpt is bounded and public, that the manual is source-checked, and that structured tools are separate, providing context beyond annotations.

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?

The description is three sentences with each sentence adding unique value: what it does, how to get complete manual, and relationship to structured tools. No fluff.

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 and rich annotations, the description covers the tool's purpose, relationship to search, and limitations. However, the lack of explanation for offset and max_characters prevents a perfect score.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 33% with only 'id' described. The description mentions id indirectly via 'returned by worlds_search_knowledge' but does not explain offset or max_characters. The term 'bounded' hints at max_characters but is insufficient for two undocumented parameters.

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 uses a specific verb 'Read' and identifies the resource as 'the bounded public excerpt and metadata for one source-checked CLI manual returned by worlds_search_knowledge.' It distinguishes from sibling tools by mentioning the source search and contrasting with structured CLI command tools.

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 states the tool is for documents returned by worlds_search_knowledge and advises following canonical_url for the complete manual. It also clarifies that structured CLI command tools remain complete, indicating when not to use this tool.

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.

TDQS

A4.2/5.0
Disambiguation4/5

Most tools target distinct resource types (commands, configurations, workflows, models, versions, documents, catalogs), but some boundary overlap exists: 'worlds_advise_hard_problem' and 'worlds_plan_cli_work' both select model/effort pairings, and 'worlds_search_cli_reference' vs 'worlds_search_knowledge' both touch workflow content. The detailed descriptions help, but an agent might occasionally hesitate between these pairs.

Naming Consistency5/5

All tools share the 'worlds_' prefix and follow a consistent verb_noun pattern: advise, compare, get, list, plan, search. Minor pluralization differences (workflows vs workflow) are negligible and do not break the pattern.

Tool Count5/5

With 12 tools, the set is well-scoped for a knowledge server covering three CLIs. Each tool serves a distinct retrieval, search, or planning need without feeling bloated or insufficient.

Completeness5/5

The server provides thorough read-only coverage: searching manuals and reference, retrieving specific commands/configurations/workflows/documents, listing catalogs/models/versions, comparing workflows, and planning/advising. There are no obvious gaps or dead ends within its stated purpose.

Resources