Skip to main content
Glama

Get research guidance document

get_research_guidance_doc
Read-onlyIdempotent

Use this AFTER search_research_guidance when you need the full text of a guidance document (not just the matched excerpt), for example to quote a passage or follow a checklist end-to-end. Pass the doc_id from a search hit.

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": {
      "doc_id": "<doc_id>"
    },
    "name": "get_research_guidance_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
doc_idYesGuidance document UUID, from a `search_research_guidance` hit. NOT a corpus paper_id (those come from `search_papers`).

Output Schema

NameRequiredDescriptionDefault
tagsYes
titleYes
authorNo
doc_idYes
contentNoThe full guidance document text, reassembled from its sections. Use this to quote a passage or follow a checklist end to end (vs the matched excerpt from search_research_guidance).
sectionsNoThe same body split by section heading, in document order.
source_urlNo
author_affiliationNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. The description adds useful behavioral context beyond that: the response is the complete document text, not an excerpt, which is the main thing an agent needs to know before calling. It does not mention what happens with an invalid or stale doc_id, or whether very long documents are truncated.

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?

Two short sentences with no filler, and the ordering constraint is front-loaded before the parameter note. Every clause carries actionable information.

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 single-parameter read tool with an output schema and full annotation coverage, the description covers purpose, sequencing, and the excerpt-vs-full-text distinction. Minor gaps remain around error behavior and document size, but nothing essential to a correct call is missing.

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 schema description already explains that doc_id is a guidance document UUID from a `search_research_guidance` hit and not a corpus paper_id. The description's 'Pass the `doc_id` from a search hit' largely restates that, so it adds little beyond the schema, making the baseline 3 appropriate.

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 (get) and resource (full text of a guidance document), and explicitly contrasts with the sibling `search_research_guidance` by clarifying it returns the full document rather than the matched excerpt. An agent can distinguish the two without opening either schema.

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 explicit sequencing ('Use this AFTER `search_research_guidance`') plus the selecting condition (need full text, e.g. to quote a passage or run a checklist end-to-end). This names both the prerequisite tool and the situations that justify the call over the alternative.

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.