Skip to main content
Glama

Read article

get_guide
Read-only

Full text of a knowledge-base article in Markdown.

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": {
      "topic": "<topic>",
      "slug": "<slug>"
    },
    "name": "get_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault
langNoContent language (ISO 639-1). Default: enen
slugYes
topicYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered; the description's contribution is the Markdown return format, which is genuinely useful. It says nothing about behavior for unknown topic/slug (error vs empty), language fallback, or article size, which for a lookup tool would be the meaningful additions.

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 short sentence with zero filler, front-loaded on the resource. It is appropriately sized, though it errs toward under-specification rather than being wasteful.

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?

For a low-complexity read tool whose safety profile is covered by annotations, the description conveys the essential outcome and payload format. However, with no output schema and no guidance on required identifiers or failure modes, an agent still has gaps to close before calling it confidently.

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%: lang is documented in the schema, but slug and topic have no description anywhere. The description does not compensate by explaining what a 'topic' is or where slugs originate (presumably from search_guides), leaving the two required parameters ambiguous.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The noun phrase 'Full text of a knowledge-base article in Markdown' identifies the resource precisely and even names the return format, so an agent knows it retrieves a complete document rather than a list. The retrieving verb is only implied by the tool name and no sibling (search_guides, get_course) is referenced, so it does not self-differentiate.

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?

There is no explicit statement of when to call this instead of search_guides, nor any note that topic/slug typically come from a prior search result. The word 'Full text' hints at a follow-up step but the sequencing is left entirely to inference.

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