Skip to main content
Glama

What references a record

what_references
Read-onlyIdempotent

Lists every record that references a given record and through which field, across modules, so you can see the impact before changing it.

Instructions

Every record that points at this one, and through which field: the items that assess an objective, the modules that declare it, the prerequisites that rely on it, the notes written on it. Ask it before changing a record, to see what the change would reach, including in other modules.

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": {
      "type": "<type>",
      "id": "<id>"
    },
    "name": "what_references"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesThe record's id, as Type/local (LearningObjective/lateral-reading-check) or the local part alone.
refNoA commit id to read at, as an earlier answer named it: pass the commit from your first answer to every follow-up, so the conversation reads one state of the design. Pass this or branch, not both.
typeYesThe record's class, such as LearningObjective, AssessmentItem, Module or DesignNote.
branchNoThe branch to read at its latest commit. Leave out to read the default branch (main unless configured otherwise). Pass this or ref, not both.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, so the safety profile is covered. The description adds value beyond that: it states the result includes the referencing record and the field that points back, and notes that reach can extend to other modules, which is genuine impact-analysis context.

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?

Two sentences: the first front-loads what is returned and its shape, the second front-loads the call-to-action. No filler, no restatement of the title.

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 read-only, four-parameter tool with no output schema, the description conveys enough: what is returned (referencing records plus the pointing field) and why to call it. It leaves open whether the lookup is direct-only or transitive, which matters somewhat for a reference-traversal tool, but the core call decision is covered.

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 id, type, ref and branch with examples and the ref/branch mutual exclusion. The description only loosely grounds the type parameter by naming example record kinds; it adds nothing about versioning semantics beyond what the schema states. Baseline 3 applies.

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 a specific operation on a specific resource: 'Every record that points at this one, and through which field', which is clearly an inbound/reverse-reference lookup. That is distinguishable in intent from outbound-style siblings like trace_record or get_record, though it does not name any sibling to sharpen 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?

It gives an explicit usage condition — 'Ask it before changing a record, to see what the change would reach' — which is real decision guidance. It does not name an alternative tool or state when not to use it, so it stops short of full routing guidance.

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