Skip to main content
Glama

list_unannotated_files

Identifies code files missing or having stale annotations so you can update them and keep natural-language project search accurate.

Instructions

Lists code files that have no annotation (or a stale one), so you can
annotate them with save_annotation().

Recommended workflow: after finishing work on a file, save/refresh its
annotation; periodically run this tool and annotate the backlog — that is
what makes natural-language search over this project accurate.

Args:
    limit: Max files per category (default 20).

Returns:
    Missing and stale annotation lists + coverage stats.

Input Schema

NameRequiredDescriptionDefault
limitNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.12.0

TDQS

A4.2/5.0
Behavior3/5

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

With no annotations provided, the description carries the full behavioral burden. It transparently explains that it returns missing and stale annotation lists plus coverage stats, and that limit applies per category, but it does not define what makes an annotation stale or whether this depends on a prior index.

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?

The description is front-loaded with the core purpose, followed by workflow context and then parameter and return details. The Args/Returns structure is efficient and every sentence contributes useful selection or invocation context.

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 simple one-parameter listing tool with an output schema, the description covers purpose, workflow, the limit parameter, and the return categories. Minor gaps remain around prerequisites and the exact stale-annotation criteria, but the core invocation context is complete.

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 0%, but the description compensates by explaining that limit is the maximum number of files per category, not just a total. The default of 20 is also stated, matching the schema.

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?

The description uses a specific verb and resource: it lists code files lacking annotations or with stale annotations. It also explicitly connects the output to save_annotation(), making its role distinct from the action-oriented sibling.

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 a clear recommended workflow: save or refresh annotations after working on a file, and periodically run this tool to find backlog files. It does not explicitly name when-not-to-use alternatives such as get_annotations(), but the usage context is clear.

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