Skip to main content
Glama

report

Read-only

Produces a full repository comparison against a base revision, covering marks, measured values, standing debt, acknowledged items, change footprint, and unanalyzed areas.

Instructions

Returns the full report of a repository against base: all marks, all measured numbers with their values at base, the standing debt item by item, the standing items the repository acknowledges, the footprint of the changes since base, and what was not analysed.

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": {
      "repository": "<repository>"
    },
    "name": "report"
  }
}

Input Schema

NameRequiredDescriptionDefault
baseNoThe revision to compare with: a commit, a tag or a branch. When it is not an ancestor of the head, their merge base is used and the answer says so. Without it, the default base the repository declares in .plimsoll.toml is used.
filesNoPaths of tracked files, relative to the repository's top folder. The report then also gives the files that import each of them.
repositoryYesAbsolute path of the repository: its top folder or any folder inside its working tree.

Output Schema

NameRequiredDescriptionDefault
baseYes
headYes
moreYes
marksYes
countsYes
historyYes
touchedYes
versionYes
evidenceNo
questionYes
resolvedYes
sectionsNo
standingYes
detectorsYes
footprintNo
summariesYes
reportOnlyYes
notAnalysedYes
acknowledgedNo
acknowledgedInNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/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 the safety profile is covered by structured data. The description does add real behavioural context by promising that un-analysed areas are reported ('what was not analysed'), which tells the agent the result is honest about coverage gaps. Beyond that it mostly restates the output content that the output schema already carries, and it says nothing about cost, repository size limits, or why idempotentHint is false on a read-only call.

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?

One front-loaded sentence that names the verb and resource first, then enumerates contents in a readable list. Every clause is meaningful, though the long enumeration overlaps with what the output schema already declares and could be tightened.

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 a full output schema, complete parameter descriptions, and annotations, the description only needs to convey scope and character of the result, which it does. The remaining gap is sibling differentiation and the default-base behaviour, both of which an agent must infer or read from the schema.

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 description coverage is 100%, so the baseline is 3. The description does add a bit beyond the schema by framing `base` as the comparison point for every reported value ('their values at `base`') and by tying the change footprint to it, making the role of the parameter concrete rather than just documented.

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 resource ('Returns the full report of a repository against `base`') and then enumerates the sections the report contains (marks, measured numbers, standing debt, acknowledged items, change footprint, un-analysed items). That is enough to tell what it produces, but it never contrasts itself with the siblings `explain` and `status`, so the boundary is only implied by the word 'full'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is only implied: calling it a 'full report' suggests it is the comprehensive option versus narrower siblings, and the enumerated sections hint at when you would want it. There is no explicit when-to-use, when-not-to-use, or prerequisite statement, and the default-base behaviour is left entirely to the schema.

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