Skip to main content
Glama

get_usage_guide

Get detailed usage guidance for Codemind's tools — how to write effective acceptanceCriteria, when to use patch mode, how webhooks work, what to do when a build declines, common failure patterns unrelated to acceptanceCriteria quality, and how to recover from an auth error without losing an identified account. Call this before build_feature/test_component/review_code if you are unfamiliar with this tool surface, or if the same story fails repeatedly across retries; call it with topic "auth" before calling create_free_account to recover from an auth error on an existing credential.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topicNoWhich part of Codemind usage to get guidance on. Defaults to overview.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior3/5

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

No annotations are provided, so the description carries the disclosure burden. It conveys intent and call timing well, and the tool is implicitly a safe read of documentation, but it never states side effects, whether the call is read-only, or what the response contains. For a pure knowledge-retrieval tool this is adequate but not rich.

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?

Purpose is front-loaded in the opening clause, and each subsequent clause maps to a topic or a routing rule rather than padding. It is dense — essentially two long sentences with embedded lists — but nothing appears redundant with the schema.

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 one-parameter, zero-required, annotation-free retrieval tool with no output schema, the description covers purpose, call timing, and topic routing well. The only real gap is the unmentioned "cloud-swarm" topic and any indication of the response shape, both minor here.

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 coverage is 100% with an enum and a per-field description, so the baseline is 3. The description lifts this above baseline by mapping topic values to concrete content (acceptanceCriteria guidance, patch mode, webhooks, error handling, auth recovery) and by prescribing "auth" for a specific recovery scenario.

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 and resource ('Get detailed usage guidance for Codemind's tools') and then enumerates the concrete subject matter covered (acceptanceCriteria authoring, patch mode, webhooks, build declines, auth recovery). No sibling tool provides guidance, so it is trivially distinguishable from build_feature, review_code, etc.

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

Usage Guidelines5/5

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

Gives explicit triggers: call before build_feature/test_component/review_code when unfamiliar with the surface, or when the same story fails repeatedly across retries. It also routes a specific case — topic "auth" before create_free_account to recover from an auth error — naming both the alternative and the condition that selects it.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources