Skip to main content
Glama

Document references

references
Read-onlyIdempotent

List labelled targets (headings, figures, equations, tables) with their numbering.

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": {
      "document": "<document>"
    },
    "name": "references"
  }
}

Input Schema

NameRequiredDescriptionDefault
documentYesThe Publisle document: an object with schemaVersion and blocks, as returned by the other tools.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.3/5.0
Behavior3/5

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

The annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, so safety and repeatability are covered. The description adds the useful behavioural fact that results are labelled targets with numbering, but says nothing about ordering, whether unlabelled items are excluded, or how targets are identified. Given the strong annotation coverage, this is a modest but real addition.

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?

One front-loaded sentence enumerating the target kinds and the returned numbering, with no filler or redundant restatement of the tool name.

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?

There is no output schema, so the description carries the burden of describing the return value; it does so only partially, naming target kinds and numbering but not the returned fields, ordering, or identifier format. For a simple one-parameter read tool this is adequate but leaves an agent guessing at the response shape.

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?

There is a single required parameter whose schema description coverage is 100%, so the schema already explains the document object shape. The description never mentions the document parameter, adding no syntax, format, or source meaning beyond the schema, which is the expected baseline when the schema does the heavy lifting.

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 description opens with a specific verb and result ("List labelled targets") and enumerates the target kinds (headings, figures, equations, tables) plus the numbering that comes back, so the agent knows exactly what the tool returns. It does not name a sibling such as outline or list_blocks, so the boundary with those tools is left implicit.

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 when-to-use or when-not-to-use guidance at all; the sentence only describes output. With a sibling named outline that plausibly overlaps, an agent gets no signal about which to pick for cross-reference enumeration versus document structure.

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