Skip to main content
Glama

Get reference details

get_references
Read-onlyIdempotent

Get full detail for one or more references by id (from search_references, similar_references or random_references): what it is, the "steal" field (the one idea worth exploring in it), patterns, typical uses, benefits, caveats, links, similar references and, for some sites, design_md (a DESIGN.md with approximate design tokens). Caveats list the known limits of each reference.

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": {
      "ids": "<ids>"
    },
    "name": "get_references"
  }
}

Input Schema

NameRequiredDescriptionDefault
idsYesReference ids (1-20).
langNoLanguage of the returned text: "en" (default) or "pt".

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/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 safety is covered. The description adds real behavioral context beyond them: it spells out the returned content including the conditional 'design_md' available only 'for some sites', and clarifies that caveats are per-reference known limits. It does not say what happens with unknown or partially invalid ids, which is the main remaining gap.

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?

The action and id provenance are front-loaded in the first clause, with payload detail trailing. The field enumeration is dense but justified because there is no output schema. The final sentence restating caveats slightly repeats the earlier 'caveats' list item, a minor redundancy.

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?

With no output schema, the description carries the full burden of explaining returns, and it does so thoroughly, including the conditional design_md field. For a two-parameter read tool it is nearly complete; only error/partial-result handling for bad ids is left unaddressed.

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 description coverage is 100%, so the schema already documents both 'ids' (1-20) and the 'lang' enum with its default, giving a baseline of 3. The description adds the provenance meaning of ids (where to obtain them) but says nothing about 'lang' or the batching implication of the 1-20 bound.

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 and resource ('Get full detail for ... references by id') and immediately disambiguates from siblings by naming the three tools that produce ids (search_references, similar_references, random_references). It also enumerates the payload, so an agent knows this is the detail-expansion step rather than a search.

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?

The parenthetical naming search_references, similar_references and random_references is explicit routing guidance: come here with ids harvested elsewhere. There is no explicit when-not guidance (e.g. don't call with ids from an unrelated collection, or the cap of 20 ids being a batching constraint), which keeps it short of a 5.

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