Skip to main content
Glama

Get ONES Document

get_doc
Read-onlyIdempotent

Retrieve ONES documents by URL or requirement reference and return structured views optimized for AI processing or human readability.

Instructions

Get ONES doc by context ref (URL or #requirement) and return llm/human structured views.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
refYes
viewNollm
include_rawNo
include_resourcesNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
docYes
llm_viewNo
human_viewNo
rawNo
Behavior4/5

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

Annotations already provide readOnlyHint, destructiveHint, idempotentHint, and openWorldHint. The description adds that it returns 'llm/human structured views', which clarifies the output format. No contradictions.

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, concise sentence that immediately conveys the tool's purpose and key input structure. No unnecessary words.

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

Completeness3/5

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

Given 4 parameters and a rich annotation set, the description is minimal. While output schema exists (reducing need for return value explanation), the missing parameter details and lack of usage context reduce completeness.

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 0%, so description must compensate. Only the 'ref' parameter is explained ('context ref (URL or #requirement)'). The 'view', 'include_raw', and 'include_resources' parameters are not described, leaving their semantics unclear.

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 states the verb 'Get', the resource 'ONES doc', and the identification method 'by context ref (URL or #requirement)'. It distinguishes from sibling tools like get_doc_chunks or get_doc_section, which have different scopes.

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?

No guidance on when to use this tool vs siblings (e.g., get_doc_chunks, get_doc_context). The agent must infer from the name, but alternatives are not addressed.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/twodogwang/mcp-demo'

If you have feedback or need assistance with the MCP directory API, please join our Discord server