Skip to main content
Glama

Update User Story

update-user-story
DestructiveIdempotent

Sync a user story markdown file to the platform after local edits. Requires frontmatter id: US- (platform-issued). Missing id returns an error telling you to call create-user-story first. Parses frontmatter (id, title, priority) and updates the linked support file and entity. Optional agentTraceability records UPDATED Activity inline.

Input Schema

NameRequiredDescriptionDefault
botIdNoQA bots: your botId from your stored TestChimp binding.
gitShaNo
userIdNo
contentYes
actorTypeNo
agentModelNo
branchNameNo
cliVersionNo
policyFileNo
workflowIdNo
skillVersionNo
policyVersionNo
projectApiKeyNoQA bots: your own project API key from your stored TestChimp binding. Required on every call except get-bot-credentials, get-project-credentials and get-bot-compat. Never print it.
agentTraceabilityNo
workflowExecutionIdNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / botId
      Added value: +{
      +  "description": "QA bots: your botId from your stored TestChimp binding.",
      +  "maxLength": 64,
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / projectApiKey
      Added value: +{
      +  "description": "QA bots: your own project API key from your stored TestChimp binding. Required on every call except get-bot-credentials, get-project-credentials and get-bot-compat. Never print it.",
      +  "maxLength": 256,
      +  "minLength": 8,
      +  "type": "string"
      +}
  2. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, destructiveHint=true, and idempotentHint=true. The description supports these with concrete behavior: it parses frontmatter (id, title, priority), updates both the linked support file and entity, and optionally records an UPDATED Activity via agentTraceability. It never spells out what the destructive update overwrites, but the sync semantics are well conveyed.

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?

Four tightly-packed sentences with the core purpose front-loaded and the error-routing detail immediately after. Nothing is wasted, though the frontmatter parsing and traceability details could be trimmed slightly.

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 mutation tool with no output schema, the description covers the essential workflow: the required id, the error behavior, what gets updated, and the inline traceability record. Gaps remain around credential requirements and what the destructive update replaces, but an agent has enough to invoke it correctly in the happy path.

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 description coverage is only 13% across 15 parameters, so the description must carry the load and largely does not. It mentions the agentTraceability object inline and implies the frontmatter fields, but the many provenance parameters (gitSha, userId, actorType, workflowId, cliVersion, etc.) are explained nowhere. The one required param, content, is only indirectly described.

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 ('Sync a user story markdown file to the platform after local edits') and scopes the operation to post-edit syncing. It clearly differentiates itself from siblings by naming create-user-story as the tool to call when the id is missing.

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?

Pinpoints the triggering condition ('after local edits') and explains the fallback path: a missing frontmatter id errors and routes the agent to create-user-story. It never states when not to use it or how it relates to get-user-stories, so it stops short of the explicit exclusion case.

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.