Skip to main content
Glama

revoke_plan_share_links

Destructive

Turn off every live private link for a plan. Returns how many were live. (confirm-gated: previews until confirm: true)

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": {
      "planType": "<planType>",
      "planId": "<planId>"
    },
    "name": "revoke_plan_share_links"
  }
}

Input Schema

NameRequiredDescriptionDefault
planIdYes
confirmNoMust be true to actually execute. If false/omitted, returns a preview only.
planTypeYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations only declare destructiveHint=true; the description adds real value by stating it affects EVERY live link at once (blast radius), that it returns a count of previously live links, and that it is preview-only until confirm is true. It stops short of saying whether revoked links can be restored or what happens to already-used/expired links, which is the main remaining gap for a destructive operation.

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?

Three short sentences: action and scope first, return value second, safety mechanics last. No redundant restatement of the tool name and no filler.

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 simple destructive tool with no output schema, the description covers what it does, what it affects, what it returns, and how to safely execute it. Missing only edge-case behavior (irreversibility, treatment of expired links) that would fully round it out.

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

Parameters2/5

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

Schema coverage is only 33% — only confirm is documented in the schema. The description says nothing about planId or planType (WORKOUT vs DIET), so it doesn't compensate for the low coverage. The enum values are self-explanatory, but the description adds no semantic detail beyond the confirm gate already described in the schema.

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?

"Turn off every live private link for a plan" gives a specific verb (turn off) plus resource (share links) and scope (all live links for one plan). It clearly separates itself from siblings like create_plan_share_link, get_plan_share_info, and revoke_client_portal_links, which target different link types.

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?

The description makes the bulk-revoke use case explicit and explains the confirm-gated preview behavior, so the agent knows how to invoke it safely. It doesn't name alternatives (e.g. get_plan_share_info to inspect links first, or revoke_client_portal_links for the other link type), so the routing picture is slightly incomplete.

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.