Skip to main content
Glama

Edit Map

edit_map
Destructive

Read or update a Map's destination, notes, fog patches, or out-of-scope items without rewriting other sections, using revision checks to prevent concurrent overwrites.

Instructions

Read a Map's Destination and Notes, or edit one typed section — set Destination or Notes, add or graduate a fog patch, rule something out of scope — without rewriting the others. Decisions-so-far is generated from resolved Tickets and never accepted as input. Mutations pass expected_revision from a prior read so concurrent sessions cannot clobber each other.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rootNoWorkspace directory. Defaults to the session workspace.
notesNoReplace the Notes section.
createNoStart a missing Effort and its Map. Only for Effort/Map that do not exist yet — not a flag to send on every call. Does not change revision rules for mutations on an existing Map; create with no section fields reads an existing Map like a plain read.
effortYesEffort slug whose Map to read or edit.
add_fogNoAppend a fog patch under Not yet specified.
rule_outNoAppend a hand-ruled item under Out of scope. Never touches Decisions-so-far.
destinationNoReplace the Destination section.
graduate_fogNoRemove a fog patch matched on its text. Fails when none match.
expected_revisionNoRevision from a prior edit_map read. Required when overwriting an existing Map; omitted when creating one.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.4.1
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. Changed1 schema field changedv0.2.1
    • changedInput schema / properties / create / description
      Previous value: -"Start the Effort and its Map if neither exists. Otherwise an unknown slug fails."New value: +"Start a missing Effort and its Map. Only for Effort/Map that do not exist yet — not a flag to send on every call. Does not change revision rules for mutations on an existing Map; create with no section fields reads an existing Map like a plain read."
  3. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already mark this as destructive and non-idempotent; the description adds genuinely useful behavior beyond that: expected_revision provides optimistic concurrency so concurrent sessions cannot clobber each other, and Decisions-so-far is always derived from Tickets rather than accepted as input. This meaningfully discloses important side effects and invariants.

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?

The description is three tight sentences with no filler: the first front-loads the read/edit capability and operation types, the second states a key invariant, and the third explains the revision requirement. Every sentence earns its place.

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 nine-parameter tool with full schema descriptions and no output schema, the description covers the essential context: partial edits, the Decisions-so-far invariant, and the expected_revision concurrency mechanism. It could slightly expand on what a read response contains, but 'Read a Map's Destination and Notes' plus the revision requirement gives the agent enough to invoke it correctly.

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%, so the baseline baseline is 3. The description adds extra meaning by explaining the concurrency role of expected_revision and by explicitly stating that Decisions-so-far is never accepted as input, which helps the agent understand an important non-obvious constraint not encoded in the schema.

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?

The description names a specific resource ('Map') and a specific verb set ('Read ... or edit one typed section'), then lists concrete operations: set Destination or Notes, add/graduate a fog patch, rule out of scope. This clearly differentiates edit_map from sibling ticket-centric tools like create_tickets and update_ticket.

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?

The description gives clear context: use it to read the Map's sections or make a single typed edit without rewriting the others, and never to supply Decisions-so-far. It does not explicitly name alternative sibling tools or say when not to use it, but the edit-versus-read framing and mutation constraints provide solid usage guidance.

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