Skip to main content
Glama

Update a help center collection

update_collection
Destructive

Change a collection's title, description, icon, order, visibility or whether the help center offers to ask the agent there. Only the fields given change.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
iconNoA Lucide icon name.
tintNo
orderNoWhere it sorts on the help center home, lowest first.
titleNo
askAgentNoOffer "Ask the agent" in this collection.
productIdYesProduct id from list_products.
collectionYesThe collection id from list_articles.
visibilityNo
descriptionNoEmpty clears it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=true and idempotentHint=false, and the description adds genuine behavioral value by stating the update is partial ('Only the fields given change'). It does not, however, acknowledge the destructive aspect flagged in annotations (e.g., that clearing description irreversibly overwrites a value) or any permission requirements.

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 short sentences, zero filler. The mutable-field inventory comes first and the partial-update rule is stated immediately after, so the most decision-relevant facts are front-loaded.

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 nine-parameter mutation tool with no output schema, the description covers the field set and patch behavior adequately, and annotations supply the safety profile. It is slightly thin on consequences (what destructiveHint=true means here, any auth requirements), which keeps it short of a 5.

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?

With 9 parameters at 67% schema coverage, the schema carries most of the load (productId and collection even point to list_products/list_articles). The description recaps six of the mutable fields by name but adds no format or value semantics beyond the parameter names, and says nothing about tint, the two required ids, or the enum values for visibility.

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 names a specific verb (Change) and resource (a collection) and enumerates the mutable fields, so an agent can tell it apart from create_collection or update_article. It does not, however, explicitly contrast itself with any sibling tool.

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?

Use is implied (modify an existing collection) and the phrase 'Only the fields given change' signals patch semantics, which is helpful context. But there is no explicit when-to-use/when-not guidance and no named alternative such as create_collection for new collections.

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