Skip to main content
Glama

NEARpedia

get_doc

Read the FULL text of one indexed NEAR documentation page by id (NEAR node and developer docs plus partner docs) — exact commands, flags, and whole sections a search snippet truncates. Best for NEAR operational/how-to questions. NEAR docs only, not the docs of other projects or the web. Get the id from search or semantic_search first.

Input Schema

NameRequiredDescriptionDefault
idYesDoc page ID (from search/semantic_search results)

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?

With no annotations, the description carries the full burden, and it does disclose that this is a read of full untruncated content including exact commands, flags, and whole sections, which implies read-only behavior and potential large payloads. It stops short of stating what happens with an invalid or stale id, or any size/response limits for very long pages.

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?

Three tight sentences, front-loaded with the verb and resource, then value proposition, then scope and prerequisite. Every clause adds a constraint or routing cue; 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?

For a one-parameter retrieval tool with no output schema, the description covers what is returned (full page text with commands, flags, sections), the domain boundary, and how to obtain the id. The only meaningful gap is the absence of any note on response size or failure behavior for an invalid id.

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% and the single parameter is already documented, so the baseline would be 3. The description adds genuine value by specifying the provenance of the id ('from search or semantic_search first') and narrowing the accepted domain to NEAR doc page ids, which the schema does not convey.

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?

States a specific verb and resource ('Read the FULL text of one indexed NEAR documentation page by id') plus the content domain (NEAR node and developer docs plus partner docs). It explicitly distinguishes itself from the retrieval siblings by contrasting full text against 'a search snippet truncates'.

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?

Gives a positive selection rule ('Best for NEAR operational/how-to questions'), explicit exclusions ('NEAR docs only, not the docs of other projects or the web'), and a prerequisite workflow ('Get the id from search or semantic_search first'). An agent knows both when to call it and what must happen before calling it.

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.