Skip to main content
Glama
Sign In
Kiln

Kiln

by codeofaxel
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python

retire_manual_revision

Destructive

Soft-delete a manual revision by supplying the manual ID and reason; this records why it was retired and preserves the audit trail.

Instructions

Soft-delete a manual revision (Business+, owner-only).

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": {
      "manual_id": "<manual_id>",
      "reason": "<reason>"
    },
    "name": "retire_manual_revision"
  }
}

Input Schema

NameRequiredDescriptionDefault
reasonYesWhy it is being retired; recorded with the revision for the audit trail.
manual_idYesThe manual revision to retire.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.5.1
    • addedInput schema / properties / manual_id / description
      Added value: +"The manual revision to retire."
    • addedInput schema / properties / reason / description
      Added value: +"Why it is being retired; recorded with the revision for the audit trail."
  2. Addedv1.5.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and readOnlyHint=false, so the safety profile is known. The description adds meaningful behavior beyond that: the deletion is a soft-delete and is restricted to Business+ owners. It still does not describe recoverability or audit-trail effects, but with annotations present this is solid.

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?

A single front-loaded sentence with no wasted words; the key operation and constraints are immediately visible.

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 two-parameter mutation with full schema coverage and annotations covering destructiveness, the description supplies the essential soft-delete and permission context. It could mention recoverability or post-retirement behavior, but nothing critical is missing.

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 coverage is 100%, so both manual_id and reason are already documented, including the audit-trail purpose of reason. The description adds no parameter-level meaning beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb ('Soft-delete') and resource ('manual revision'), and adds scope constraints (Business+, owner-only). It does not name a sibling alternative, so it is clear but not fully differentiated from tools like get_manual_revision or list_manual_history.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It states prerequisites (Business+ plan, owner-only access), which gives clear context for when the call is permitted. It does not say when to retire versus restore/archive or name alternatives, so usage remains implied.

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

Deploy Server

Other Tools