Skip to main content
Glama

record module

record_module
DestructiveIdempotent

Store a module the owner has approved: its number, title, summary, and the outcome it serves. An occupied module number is preserved unless replaceExisting is true and the owner requested replacement. Identical retries return the saved module. This does not by itself lock a module outcome.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleYes
summaryYes
programIdYes
moduleNumberYes
outcomeTitleNo
replaceExistingNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

With annotations supplied (idempotentHint, destructiveHint, readOnlyHint=false), the description usefully adds the collision/overwrite rule for an occupied module number and the idempotent-retry behavior. It also clarifies scope by noting it does not lock an outcome. It omits bit-for-bit why it's destructive and what errors arise, but the added context is well above the annotation baseline.

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?

Three tight sentences, front-loaded with the core action, then the collision rule, then the retry/scope caveats. Every sentence carries new information and there is no filler.

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 create/upsert mutation with annotations and an output schema present, the description covers the key behavioral edge cases (occupied number, retry idempotency, no outcome lock). It doesn't discuss validation errors, permission requirements, or the output shape, but the output schema presumably handles the latter.

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%, so the description must carry the load, and it names module number, title, summary, and outcome. It also explains replaceExisting's meaning (allow overwrite of an occupied number). It does not clarify programId's role or that outcomeTitle is a separate field from the required summary/title.

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?

States a clear verb (Store) and resource (a module) and enumerates the payload fields (number, title, summary, outcome it serves), which distinguishes it from sibling tools like record_module_outcome and list_modules. It doesn't explicitly name a sibling to route away from, but the purpose is unambiguous.

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 description implies usage — this is for persisting an owner-approved module — but gives no explicit when-to-use vs when-not guidance and doesn't reference any sibling tool as an alternative. The implicit 'owner-approved' condition is the only usage signal.

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