Skip to main content
Glama

overlay_ls

Read-onlyIdempotent

Lists every overlay bottom-to-top with position, lane, and span, marking cut-unresolved stacks as overlays_error for targeted fixes.

Instructions

Every overlay, bottom of the stack first, with where each plays now.

Each carries its position (as overlay_rm takes it), its lane, and its timeline span. A stack that cannot resolve — a cut removed a start word — comes back as overlays_error beside the stored records, so the one to move or remove can still be found.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoThe project directory to act on. Omit it — the usual case — when this server is bound to a project (started as `proofcut -C DIR mcp`, or inside a project; `ping` says which): it then resolves to that one bound project, a relative path resolves against it, and a path outside it is refused by name. Unbound, `path` is the whole address and omitting it refuses rather than guessing.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.36.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, so the safety profile is covered. The description adds valuable behavioral context: the ordering (bottom of stack first), the error behavior when a stack cannot resolve (returns overlays_error beside stored records), and the purpose of carrying position/lane/span. This goes beyond annotations and helps the agent understand edge cases.

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 compact and front-loaded: the first sentence states the core function and ordering. The second sentence adds essential detail about error handling and the data carried. Every sentence earns its place, and there is no fluff or repetition of schema content.

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?

The description is complete for a read-only listing tool. It explains ordering, data carried, and error behavior. The output schema exists, so return values don't need to be described. The only minor gap is not explicitly stating when to prefer this over overlay_rm or overlay_add, but the read-only nature and listing purpose are clear from annotations and description.

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 fully documents the single optional 'path' parameter. The description doesn't add parameter-specific semantics beyond what the schema provides, but it does explain the context of the returned data (position, lane, span) which indirectly clarifies what the tool operates on. Baseline 3 is appropriate given full schema coverage.

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 states a specific verb and resource: list every overlay, bottom of the stack first, with where each plays now. It also distinguishes itself from sibling tools like overlay_add and overlay_rm by focusing on listing, and it explains the ordering and the data carried per overlay. This is clear and specific.

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 description implies when to use this tool: when you need to see all overlays and their positions, lanes, and timeline spans. It doesn't explicitly name alternatives or exclusions, but the context of listing vs. adding/removing is clear from the sibling names and the description's focus on enumeration. It could be stronger with an explicit 'use this instead of overlay_rm when you need to inspect before removing' but the context is sufficient.

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