Skip to main content
Glama
thenavidm
by thenavidm

Ban a partner

ban_partner
Destructive

Block a partner from your program by disabling all links and canceling their commissions. Provide a valid reason and partner ID to enforce.

Instructions

Ban a partner from your program. This will disable all links and mark all commissions as canceled.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
reasonNoThe reason for banning the partner.
accountNoExact configured private workspace profile label; not a tenant or provider account ID.
confirmNoMust be true for the requested mutation or exclusive private output file.
payloadNoComplete native JSON body; do not mix with body flags or payload_file. Arrays use repeated JSON object flags or a whole native array in a private file.
tenantIdNoThe ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.
partnerIdNoThe ID of the partner to create a link for. Will take precedence over `tenantId` if provided.
payload_fileNoAbsolute regular non-symlink JSON body file, at most 1 MiB. Cannot mix with payload/body flags.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=false, but the description goes beyond them by naming the actual side effects: all links are disabled and all commissions are marked canceled. That is genuine disclosure of destructive scope. It does not mention the confirm=true gate, so it falls short of a 5.

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?

Two lean sentences, the purpose front-loaded and the consequence immediately after. Nothing redundant or padding.

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 destructive mutation with a nested payload, 100% schema coverage, and no output schema, the description covers purpose and effect well. The one meaningful omission is the confirm=true requirement for the mutation, which an agent only learns from the schema.

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%, so the schema already documents reason, account, confirm, payload, and the partnerId/tenantId precedence rules. The description adds no parameter-level meaning beyond that, making the baseline 3 appropriate.

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?

States a specific verb and resource ('Ban a partner from your program') and adds the concrete effect (disables links, cancels commissions), which helps distinguish it from the sibling deactivate_partner. However, it never explicitly contrasts itself with deactivate_partner or the other partner tools, so an agent still has to infer the distinction.

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

Usage Guidelines2/5

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

There is no when-to-use guidance, no prerequisites, and no mention of the close alternative deactivate_partner that sits right beside it in the tool list. The agent must guess whether banning or deactivating is the correct escalation.

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