Skip to main content
Glama

Project Check References

project_check_references
Read-only

Check a project's assembly manifest and item registry for broken cross-file references before merging, including missing files, unknown IDs, invalid instances, and naming violations.

Instructions

Reference-integrity guard (issue #143 / D1) — catch a broken cross-file reference before a merge (the chronic PDM failure mode). Loads a project's assembly manifest + item registry and checks every reference resolves: a moved / renamed / missing component file, a dangling item-ref (an unknown id, or a resolved file missing on disk), an instance naming an unknown component, and naming-convention violations.

project: path to the project.json container.

Returns {ok, problems} — ok is True iff every reference is live, so a broken reference is reported here instead of as a cryptic merge failure.

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": {
      "project": "<project>"
    },
    "name": "project_check_references"
  }
}

Input Schema

NameRequiredDescriptionDefault
projectYes
workspaceNoRun this call in this named workspace

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.5.7
    • addedInput schema / properties / workspace
      Added value: +{
      +  "default": "",
      +  "description": "Run this call in this named workspace",
      +  "title": "Workspace",
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint=true, openWorldHint=false), so the bar is lower; the description still adds real context by disclosing what it loads (assembly manifest + item registry) and why the check matters (avoiding a cryptic merge failure). It does not describe cost, scope limits, or problem-object shape, but there is no contradiction with annotations.

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 core statement is front-loaded and the return contract is stated in one short line at the end. The parenthetical '(issue #143 / D1)' and 'chronic PDM failure mode' framing are internal jargon that consume space without helping tool selection.

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 correctly supplies the return contract ({ok, problems} with ok defined as 'every reference is live'). Combined with read-only annotations and the enumeration of checked conditions, an agent has enough to call it correctly; only the structure of individual problem entries is unspecified, which is minor.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 50% — the required 'project' param has no schema description — and the description compensates by defining it as 'path to the project.json container', which is the semantic an agent needs. The optional 'workspace' param is left to the schema's own description, so the coverage gap is only partially closed.

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 ('reference-integrity guard', 'checks every reference resolves') and enumerates exactly the failure classes it detects: moved/renamed/missing component files, dangling item refs, unknown component instances, naming-convention violations. That enumeration distinguishes it from adjacent siblings like project_validate, validate_manifest, and items_check_manifest without the agent needing to open schemas.

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 usage trigger ('before a merge', to catch the 'chronic PDM failure mode'), which tells the agent when this tool earns its call. It does not name alternatives or state when not to use it versus project_validate or project_resolve_manifest, so it falls short of the explicit routing that earns a 5.

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

Deploy Server

Other Tools