Skip to main content
Glama

BotSpot: AI Trading, Backtests and Bots

Update plan item

update_plan_item
Idempotent

Updates one user-visible plan item. The target is required and must be {type:"id", itemId} or {type:"position", position}; ambiguous itemId/position top-level shapes are intentionally not accepted. Use this before or after each major action in a plan-driven task so progress does not stay stuck while work continues. When working in the current conversation, omit conversationId and planId; never pass placeholders such as current, this, or active. If you include conversationId, it must be the real UUID. If you include planId, it must be the plan UUID, not a plan item id. Keep exactly one visible plan item in_progress at a time. Plan items progress in visible order: before marking a later item in_progress, waiting, completed, or blocked, resolve earlier visible items as completed, blocked, skipped, or removed. For ordinary handoffs, complete the current item, wait for the successful result, then start the next existing item with a separate update_plan_item call. Completed items are historical attempts: preserve their outcome and use the earliest unresolved row or add_plan_item for new linked follow-up work. Omitting outcome does not clear an existing outcome. If a real attempt finished without satisfying its completion criteria, status="completed" may carry outcome.status="unsuccessful" or outcome.status="partial" and the external result belongs in patch.evidence. Follow-up items reference that item with parentItemId or dependsOnItemIds. Do not copy an external resource status into outcome.status; put external statuses in patch.evidence. Do not target a future position to create the next validation row. update_plan_item only updates existing items; if the relevant domain tool has not returned a new external id yet, execute the active item first instead of creating a waiting validation row. After the relevant domain tool has returned a new external id, use update_plan_item only for the existing current row, then call add_plan_item for the waiting validation row. For external waits, use patch.status="waiting" with patch.waitReason="waiting_for_external_event" and put domain evidence in patch.evidence, for example externalKind and externalId. Use waitReason="waiting_for_user" before asking the user for a decision. External observations from hooks do not update the plan by themselves; when a terminal external observation arrives, explicitly update the plan item if the observation satisfies or changes the completion criteria.

Input Schema

NameRequiredDescriptionDefault
patchYes
planIdNoOptional plan UUID. In the current conversation, omit planId unless you already have the actual plan id from get_active_plan or a wake message. Never pass a plan item id here; target plan items through target.itemId or target.position.
targetYes
conversationIdNoOptional conversation UUID. Omit this field to use the current MCP conversation context; never pass placeholders such as `current`.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Annotations only cover idempotency and non-destructiveness; the description adds substantial behavior: exactly one item may be in_progress, progress must follow visible order, omitting outcome does not clear an existing outcome, completed rows are historical, and outcome.status is not an external resource status. These are non-obvious invariants that would otherwise be violated.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose and target shape are front-loaded, but the body is a dense wall of text with real redundancy — the external-id/validation-row rule and the externalWaitId/patch.evidence guidance are each restated in multiple sentences. The content earns its place, but the phrasing does not.

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

Completeness5/5

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

For a nested, ordering-constrained state mutation with no output schema and only partial schema descriptions, the definition covers the rules an agent must know to call it correctly. Nothing critical about sequencing, waiting, or handoffs is missing.

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?

With 50% schema coverage, the description compensates well on the risky fields: exact target shapes ({type:"id",itemId} vs {type:"position",position}), no placeholders for conversationId, planId must be a plan UUID not an item id, and the outcome/evidence split. It still leaves label, rationale, toolName, revisionId, externalWaitId and completionCriteria unexplained in either place.

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?

Opens with a specific verb+resource ("Updates one user-visible plan item") and immediately differentiates from siblings: it "only updates existing items" while add_plan_item creates new ones, and it is the singular counterpart to update_plan_items. An agent can pick it out of a ~90-tool list without opening the schema.

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?

Explicit about when to call it (before/after each major action; on a terminal external observation), when not to (do not target a future position to create a validation row; execute the active item first if no external id exists yet), and which alternative to use (add_plan_item for new follow-up rows, remove_plan_item for removal).

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.