Skip to main content
Glama

read_links

Read-only

Retrieve inbound and outbound links for a LeafWiki page by ID or path, including broken links in both directions, to audit connections and find link issues.

Instructions

A page's links: pages linking to it, pages it links to, and broken links both ways.

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": {
      "page": "<page>"
    },
    "name": "read_links"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageYesPage id or path

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

B3.4/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 safety is covered. The description adds real value by disclosing the three result buckets returned, but says nothing about result volume, pagination, or whether missing/unreadable links are included in the broken set.

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?

A single compact sentence with the resource front-loaded and the three returned categories enumerated in order. No filler, no restatement of the tool name.

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 one-parameter read tool with no output schema, the description does the important work of stating what comes back. It stops short of describing result shape or ordering, which is the main remaining gap, but the tool is simple enough that this is a minor omission.

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?

Only one parameter exists and the schema documents it fully at 100% coverage ("Page id or path"). The description's phrase "A page's links" confirms the parameter's role but adds no syntax, format, or edge-case detail beyond the schema.

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 names the resource (a page's links) and enumerates the specific categories returned: inbound links, outbound links, and broken links in both directions. That is concrete enough to distinguish it from generic page readers, but it never names or differentiates from the sibling read_broken_links, which clearly overlaps.

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. Given the presence of read_broken_links and read_page as siblings, the agent is left to infer whether this tool supersedes them or whether broken-link checking should go through the dedicated tool.

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