Skip to main content
Glama

complete

Mark an initiative done with its reference and required docs_impact, then report which initiatives became ready.

Instructions

Mark an initiative done. docs_impact is required: the project doc paths updated in this change, or "none: ". Reports which initiatives became ready.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
refYesInitiative: "collection#n", a bare number, or a path.
collectionNo
docs_impactYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It usefully discloses the cascading effect ("reports which initiatives became ready") and the mandatory `docs_impact` format, but says nothing about irreversibility, required permissions, or whether completion can be reverted.

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?

Three short sentences, front-loaded with the action, then the hard requirement, then the observable side effect. Every sentence earns its place with no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with no annotations and no output schema, the description covers the required input and the readiness side effect, but omits the `collection` parameter's role and any auth/irreversibility context. Adequate but with clear gaps.

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 coverage is only 33%: `ref` is documented in the schema, `docs_impact` is explained well in the description (required, accepts paths or "none: <reason>"), but `collection` is undocumented in both. The description adds real meaning for one gap but leaves another open.

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?

"Mark an initiative done" states a specific verb and resource, and "Reports which initiatives became ready" clarifies the side effect. It does not, however, distinguish itself from the sibling `set_status`, which plausibly overlaps with marking an initiative done.

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

Usage Guidelines2/5

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

There is no when-to-use guidance and no mention of alternatives such as `set_status` or `ready`. The agent must infer from the name alone when completion is appropriate versus a plain status change.

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