Skip to main content
Glama

Add suggested competitor

add_suggested_competitor

Add a suggestion from get_competitor_suggestions to the list (mined deep on the next scan), as the rail's Add does. At the cap, pass swap_out_id to take out a competitor already mined deep in the same write, as the rail's Swap does. Undo an add with remove_competitor; undo a swap with restore_competitor (competitor: swap_out_id, replacing: the new id).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rootYesA suggestion's root from get_competitor_suggestions.
app_idNoProject id from list_apps. Omit to use your most recently added project.
confirmNoSet true after the user confirmed an action the guard flagged as hard to undo.
swap_out_idNoAt the cap: the competitor to take out, usually swap_out.id from get_competitor_suggestions.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.5/5.0
Behavior4/5

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

Annotations cover the safety profile (readOnlyHint=false, destructiveHint=false, idempotentHint=false), and the description adds genuinely non-obvious behavior: the suggestion is 'mined deep on the next scan' (a deferred effect, not immediate), the cap triggers a swap mode, and both operations are reversible. It also explains confirm's role via the secondary path. Minor gap: 'as the rail's Add/Swap does' is UI jargon an agent cannot resolve, and the return/receipt format is unspecified.

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?

Three dense sentences, reasonably front-loaded with the primary action before the cap/swap and undo branches. The 'rail's Add/Swap' analogies and 'mined deep' phrasing consume space without adding agent-resolvable meaning.

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 mutation tool with no output schema and full schema coverage, the description supplies the missing pieces an agent needs: source of input, cap handling, and undo paths. Only the post-call result/pagination behavior is not covered, which is a minor omission.

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

Parameters4/5

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

Schema description coverage is 100%, so the baseline is 3; the description adds meaning by tying swap_out_id to the 'at the cap' condition and clarifying it is usually swap_out.id from get_competitor_suggestions. root/app_id/confirm are left to the schema, which already documents them well.

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+resource ('Add a suggestion ... to the list') and identifies the source tool (get_competitor_suggestions) versus the sibling add_competitor, which adds competitors directly. An agent can tell what this does and where the input comes from without opening the schema.

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?

Explicit conditions: use swap_out_id when at the cap, undo an add with remove_competitor, undo a swap with restore_competitor. It names the alternatives and the trigger for each, leaving little to inference.

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