Skip to main content
Glama

GStars docs

Read a documentation page

get_doc
Read-onlyIdempotent

Return one GStars documentation page as Markdown, by the path that list_docs or search_docs returned (for example /methodology).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "path": "<path>"
    },
    "name": "get_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesPage path from list_docs.

Output Schema

NameRequiredDescriptionDefault
urlYes
pathYes
titleYes
markdownYes
descriptionYes
last_updatedYes
markdown_urlYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds that output is Markdown and that inputs are constrained to known page paths, but says nothing about behavior on an invalid path or response size, so added value beyond annotations is modest.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence with no filler; the return format and the input derivation come first. It is efficient, though it packs the alternative-tool reference into the same clause rather than separating it.

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

Completeness5/5

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

With an output schema present, annotations covering safety and idempotency, and a single fully-enumerated parameter, nothing an agent needs to invoke this correctly is missing. The description supplies the only non-structured facts: format and path provenance.

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?

Schema coverage is 100% and the path parameter already carries an enum of all eight pages plus its own description. The description adds provenance ("the path that list_docs or search_docs returned") and an example, which is helpful but largely echoes what the schema already constrains.

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 ("Return one GStars documentation page") plus the return format (Markdown) and the keying argument (path). Naming list_docs and search_docs as the path sources separates it cleanly from those siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Makes the intended workflow explicit: call this after list_docs or search_docs and pass the path they returned. It gives clear context for use but does not state an explicit exclusion or failure case, so it falls short of full when/when-not guidance.

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.

Resources