Skip to main content
Glama

Archive pipeline

archive_pipeline
DestructiveIdempotent

Archive (soft-delete) a named pipeline by pipeline_key (or pipeline_id; id wins if both are given). Refused while live opportunities are still on it — reassign those deals to another pipeline first. Recoverable by an admin (soft-delete). The workspace default pipeline can't be archived. An unknown key/id returns the known pipelines instead of an error. Admin-only. Returns the archived pipeline.

When to use: When an admin no longer needs a named pipeline. Refused while deals are still on it — reassign those first; it stays recoverable by an admin.

Example: We're done with the Waitlist pipeline — archive it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pipeline_idNoThe pipeline to archive by id (uuid). id wins if both are given.
pipeline_keyNoThe pipeline to archive, by its stable key. Prefer this.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
pipelineNo

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 destructive/safe-write/idempotent, but the description adds substantial context beyond them: soft-delete recoverability by an admin, the live-opportunity refusal, the undefeatable default pipeline, the benign unknown-key behavior (returns known pipelines rather than erroring), admin-only auth requirement, and the return value.

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?

Front-loaded with the operation and the key precedence, then prerequisites, in a logical order. It loses a point for restating the reassignment constraint twice (main body and 'When to use'), which is redundant given how compact the rest is.

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?

With annotations carrying the safety profile and an output schema covering the return value, the description still supplies everything else an agent needs: auth requirement, prerequisites, edge-case behavior, and recoverability. Nothing material 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 description coverage is 100%, and the schema descriptions already state 'id wins if both are given' and 'Prefer this.' The description reinforces the key/id precedence but adds no format or syntax detail beyond what the schema provides, so the baseline of 3 applies.

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?

States a specific verb and resource ('Archive (soft-delete) a named pipeline') and precisely names the two identifier parameters. It is clearly distinguishable from sibling archive/delete tools (archive_field, archive_object, delete_record) and from update_pipeline.

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?

The 'When to use' section states the condition ('an admin no longer needs a named pipeline') and the blocking precondition ('Refused while deals are still on it — reassign those first'). When-not guidance is explicit, not implied.

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