Skip to main content
Glama
Sign In
doc-review

doc-review

by MichaelEight
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Local

review_define_tag

Define or update workspace #tags so concept and convention definitions autocomplete in the UI and accompany comments that use them.

Instructions

Define or update a #tag for this workspace (a concept, topic or convention, e.g. #image-gs = "Gaussian splatting figures, see figures/gs/"). Tags autocomplete in the UI and their definitions are sent along whenever a comment uses them.

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": {
      "name": "<name>",
      "description": "<description>"
    },
    "name": "review_define_tag"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes
rootNoAbsolute path of the workspace folder. Optional when only one workspace is open.
filesNoRelated files, relative to the root.
descriptionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.4/5.0
Behavior2/5

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

With no annotations, the description carries the full behavioral burden. It usefully discloses that this is an upsert and that definitions propagate into comments, but it never says whether an update overwrites the previous definition, what happens to existing comments that used the old definition, whether files are replaced or merged, or what the call returns.

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?

Two sentences, purpose front-loaded, and the parenthetical example does more work than a paragraph of abstraction. No filler or restatement of the tool name.

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 four-parameter write tool with no annotations and no output schema, the description covers intent and downstream effect but leaves the mutation semantics and half the parameters unexplained. Adequate to select the tool, thin for invoking it confidently.

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

Parameters2/5

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

Schema coverage is only 50%: root and files are documented in the schema, while name and description are bare strings. The description implies name is the tag and description is its definition, but it does not resolve whether name should include the leading '#' (its own example shows '#image-gs'), nor does it explain what the files parameter does.

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 pair ('Define or update') plus the resource ('a #tag for this workspace') and disambiguates the abstract term with a concrete example (#image-gs = "Gaussian splatting figures, see figures/gs/"). No sibling tool deals with tags, so there is no confusion risk with review_open/review_comment etc.

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?

The 'define or update' phrasing implies the create-vs-edit cases, and the second sentence explains the payoff (autocomplete in UI, definitions travel with comments), which indirectly signals when to bother defining a tag. There is no explicit when-not, no mention of prerequisites (e.g. workspace must be open) and no alternative named.

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