Skip to main content
Glama

keep_writeup

DestructiveIdempotent

Keep a write-up with the report of a finished QuanterLab run of the person's own, so the report they open and share carries it.

    Call it after you have written a run's write-up for the person (when they asked for one, for example with
    the card's Write it up): pass the run's task_id and the write-up's text as you wrote it. It is kept as plain
    text, in paragraphs and short heads: links, markup and anything that is not text are taken out, and at most
    4,000 characters are kept. A second call for the same run replaces the first. A run that is still going,
    or that is not the person's, is refused in one line.

    Args:
        task_id: The task_id of the finished run the write-up is about.
        text: The write-up as you wrote it for the person.

    The answer says whether it was kept (`kept`) and gives the report's link (`report_url`) to show the person.
    

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "task_id": "<task_id>",
      "text": "<text>"
    },
    "name": "keep_writeup"
  }
}

Input Schema

NameRequiredDescriptionDefault
textYes
task_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.4/5.0
Behavior5/5

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

With annotations already flagging destructiveHint=true and idempotentHint=true, the description still adds material context: content is stored as plain text with links and markup stripped, capped at 4,000 characters, and a second call for the same run replaces the first — which directly explains the destructive/idempotent profile. It also discloses failure behavior (one-line refusal) and the response payload (kept, report_url), which matters because no output schema exists.

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?

The key action and the calling condition are front-loaded in the first two sentences, and behavioral constraints follow in a tight block. The trailing 'Args:' section and the sentence restating task_id duplicate what was already said, costing a little density but not clarity.

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 two-parameter mutation with no output schema, the description covers invocation timing, content normalization and size limit, replacement semantics, refusal cases, and the return fields. An agent could call this correctly and report the result to the user without any further information.

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

Parameters3/5

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

Schema description coverage is 0%, so the description carries the burden, and it does add real constraints on text (plain text, paragraphs and short heads, 4,000-character cap, markup stripped) plus a clarifying gloss on task_id ('of the finished run the write-up is about'). However, the Args block largely restates the parameter names, and it does not say whether transformation happens before or after the cap is applied.

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 verb and resource: attach a write-up to a finished run's report so it travels with what the person opens and shares. It also scopes the object precisely ('of the person's own', 'finished run'), which separates it from the progress/result siblings that read runs rather than annotate reports.

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?

It states clearly when to call: after writing a run's write-up for the person, e.g. when they used the card's 'Write it up'. It also names two negative conditions (run still going, run not the person's) that lead to refusal. It stops short of naming an alternative tool for those failure cases, so it is not a full when/when-not/alternative triad.

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