Skip to main content
Glama

Read the Full Manual

get_manual

Retrieve the complete md-to-word reference when unsure about style names, YAML keys, equations, CSL presets, limits, covers, numbering, or base templates.

Instructions

Read the full manual when a spelling or behaviour is not certain: every style name, YAML key, equation rule, CSL preset and known limit, plus §9 for custom covers, front matter, section/page numbering, and --base-template.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_manual"
  }
}

Input Schema

NameRequiredDescriptionDefault
langNozh

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden, and it does disclose the manual's scope and section map (§9 for covers, front matter, numbering, --base-template). It does not say whether the manual is returned in full or chunked, how large the output is, or how the response is structured, which matters for a long reference document.

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 sentence with the usage trigger front-loaded, followed by a compact coverage list. The dense enumeration of section topics earns its place as a scope claim, though the final clause is heavy enough to skim.

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?

An output schema exists, so return-value explanation is not required, and the content enumeration gives good scope. However, the undocumented lang parameter and the unresolved overlap with get_guide leave meaningful gaps for a tool whose only job is choosing the right reference source.

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?

There is one parameter (lang, default 'zh') with 0% schema description coverage, and the description says nothing about it. An agent cannot tell from either field what the parameter controls or what values are valid; the description should compensate here but does not.

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?

States a specific verb ('Read') and resource ('the full manual') and enumerates the coverage: style names, YAML keys, equation rules, CSL presets, known limits, plus §9 topics. The word 'full' hints at the distinction from get_guide, but the description never names or characterizes the sibling, so the agent must infer the contrast.

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?

Gives a clear use trigger: 'when a spelling or behaviour is not certain.' This is a concrete condition an agent can act on. It stops short of naming get_guide as the lighter alternative for quick lookups, so routing between the two reference tools is left implicit.

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