Skip to main content
Glama

update_run

Append a run status update to the workspace timeline, recording changes like queued, running, or failed with optional notes and brief association.

Instructions

Append a workspace run status update.

    Writes one JSONL status entry under the configured workspace .nogra runs directory for the sanitized run id,
    including schema, timestamp, workspace id, status, notes, and optional brief id, then returns the run resource
    URI.

    When to use:
    - Record that a run moved to a new status such as queued, running, complete, blocked, or failed.
    - Attach notes to a run timeline without changing any external transport state.

    When NOT to use:
    - Do not use this for general activity notes; use post_event for non-run events.
    - Do not use this to dispatch work or submit report artifacts; this only appends a public run update.

    Examples:
    >>> update_run("run-456", "running", notes="Audit started", brief_id="brief-123")
    {"status": "ok", "runId": "run-456", "resourceUri": "nogra://workspace/local/runs/run-456"}
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
notesNoOptional human-readable notes for this run status update.
run_idYesRun id to update; sanitized before storage and used as the run JSONL filename.
statusYesRun status text to append. Blank input is stored as updated.
brief_idNoOptional brief id to associate with the run update; sanitized before storage.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

No annotations provided, so description carries full burden. Discloses it writes one JSONL entry to workspace directory, sanitizes run_id/brief_id, returns URI. Could mention idempotency or auth but covers core behavior adequately.

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?

Well-structured with sections and example; no wasted sentences. Could be slightly tighter but overall efficient and readable.

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?

Given output schema exists, description covers purpose, usage, behavior, and includes an actionable example. No obvious gaps for an append-only run status update tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% but description adds critical context: run_id is sanitized and used as filename, blank status stored as 'updated', optional brief_id and notes with sanitization. This goes beyond schema descriptions.

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?

Starts with 'Append a workspace run status update'—specific verb and resource. Explicitly distinguishes from sibling 'post_event' by stating when not to use it for general activity notes.

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?

Provides clear 'When to use' and 'When NOT to use' sections, including explicit alternatives like post_event for general notes and not for dispatching work or submitting report artifacts.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/nograai/nogra-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server