Skip to main content
Glama

Edit a metric's definition

ledger_metrics_update
Destructive

Corrects a metric's name, unit, description, kind (measure / event), direction (which way is good), target, cadence, icon, level, or the metrics it drives (its place in the metric tree). Readings are untouched. Only what you pass changes. The slug is not editable here — external writers address metrics by slug. Fails with conflict when a rename collides with a live metric. metricId is the id from ledger_metrics_list. May return needs_confirmation.

Input Schema

NameRequiredDescriptionDefault
iconNoThe mark the metric wears in every tool: the thing it counts (phone for calls, landmark for profit). "" goes back to the catalog's icon.
kindNomeasure = a value each reading; event = a count of occurrences.
nameNo
unitNo"min", "%", "$", "tickets/day".
levelNooutcome = what the business is judged on; driver = a number that moves an outcome; activity = daily work. "" unplaces it.
drivesNoIds of the metrics this one moves. Replaces the current set; pass the full list. Loops are refused.
targetNoGoal value in the metric's unit; null clears.
cadenceNoHow often a reading is expected.
metricIdYesMetric id (from ledger_metrics_list).
directionNoup = higher is better, down = lower is better, none.
workspaceNoWorkspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalIdNoApproval id from a prior needs_confirmation envelope.
descriptionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare a write/destructive, closed-world operation, so the bar is lower — yet the description adds substantial behavior beyond them: partial-update semantics ("Only what you pass changes"), that readings are untouched, conflict-on-rename failure, and a possible needs_confirmation envelope. These are exactly the non-obvious traits an agent needs before invoking a 13-param mutation.

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?

Front-loaded with the editable facets, then the operational constraints (readings untouched, partial update, slug locked, conflict, confirmation). Dense but every sentence carries distinct information; 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 13-param mutation with no output schema, the description covers the critical gaps: partial update, non-editable slug, conflict behavior, and the needs_confirmation return signal. It does not explain the approvalId/confirmation round-trip in detail, which is the only remaining loose end.

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 85%, so the schema does most of the work (unit, kind, level, drives, target, cadence are all documented inline). The description still adds value by flagging the partial-update contract, the metricId provenance, and the non-editability of slug, which the schema does not state.

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?

Specific verb+resource ("Corrects a metric's definition") followed by the full list of editable facets, which pins down exactly what this tool mutates versus ledger_metrics_create/archive/record_reading. It also explicitly states what is NOT editable (the slug) and where metricId comes from, so an agent can distinguish it from siblings without opening any schema.

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?

Gives clear operating context: metricId must be sourced from ledger_metrics_list, the slug is out of scope here, and renames collide with live metrics. It stops short of explicit when-to-use-this-vs-create/archive routing, but the scope statements make the intended usage unambiguous.

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