Skip to main content
Glama

Remove Q&A document

remove_qa_document
DestructiveIdempotent

Removes one supporting document, by name as returned by list_qa_documents, from a deck's private Q&A.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes
slugYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

The annotations already declare destructiveHint=true and idempotentHint=true, so the removal semantics and repeat-call safety are covered structurally. The description adds only the pointer that names come from list_qa_documents; it says nothing about what happens if the name does not exist, whether permissions are required, or whether the deletion is recoverable.

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?

A single tight sentence with the action front-loaded and no filler. Every clause (scope, name source, containing location) earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema and annotations covering the destructive/idempotent profile, the essentials are present. However, for a destructive multi-tenant operation on a two-required-parameter tool, the definition leaves error behavior and the role of 'slug' unaddressed.

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 0%, so the description must carry the parameter burden. It does explain that 'name' is the document name as returned by list_qa_documents, which is genuinely useful, but it never explains that 'slug' identifies the deck, leaving one of two required parameters to inference.

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?

The description states a specific verb and resource ("Removes one supporting document... from a deck's private Q&A"), and the explicit reference to list_qa_documents clarifies what kind of document is targeted. It largely distinguishes itself from the sibling list_qa_documents, though it does not name its natural counterpart aitho_add_documents.

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?

Usage is implied rather than stated: you call it when you want to delete an existing supporting document, and the description usefully points to list_qa_documents as the way to discover valid names. There is no explicit when-not-to-use guidance and no mention of alternatives or preconditions.

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