Skip to main content
Glama
zackscriven

ghl-mcp-server-v2

by zackscriven

ghl_opportunity_delete_pipeline

DestructiveIdempotent

Permanently deletes a pipeline and all opportunities across its stages. Use only after migrating or exporting opportunities, as this action cannot be undone.

Instructions

Delete Pipeline Permanently deletes a pipeline and all opportunities within it. This action is irreversible — all opportunities across every stage of this pipeline will be removed. Ensure you have migrated or exported any opportunities before calling this endpoint. Endpoint: DELETE /opportunities/pipelines/{pipelineId} (Version header: v3; source: v3/opportunities-v3.json) OAuth scopes: pipelines.write

Input Schema

NameRequiredDescriptionDefault
pipelineIdYesThe unique identifier of the pipeline

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.1.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, so the safety profile is known. The description earns credit beyond that by spelling out the cascade ('all opportunities across every stage will be removed'), the irreversibility, and the required OAuth scope (pipelines.write).

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 action and its destructive scope, followed by a warning and then the endpoint/scope metadata. No sentence is wasted and the most important fact comes first.

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 single-parameter destructive mutation with annotations covering the safety profile and no output schema, the description supplies the cascade behavior, irreversibility, and auth scope an agent needs. Only light guidance on alternatives 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 pipelineId is documented in the schema, so the description needn't restate it. It adds nothing further about the parameter, so the baseline 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 ('Permanently deletes a pipeline') and immediately defines scope: 'all opportunities within it.' This clearly separates it from ghl_opportunity_delete (deletes one opportunity) and ghl_opportunity_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 Guidelines3/5

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

Adds a precondition - 'Ensure you have migrated or exported any opportunities before calling' - which implies caution and timing. However, it never names an alternative (e.g., update pipeline instead of delete, or delete individual opportunities first), so the when-to-use-vs-sibling guidance is only 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