Skip to main content
Glama

Update Topic

update_topic
DestructiveIdempotent

Update a single topic (priority, lifecycle state, archived status, issue type, or keywords). Before your first call, read the skill: modem_skills({ name: "write-tools" }).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topicIdYes
archivedNoSet to true to archive the topic, false to unarchive it.
keywordsNoReplace the topic keywords/categories. Provide the full list of keywords.
priorityNoUpdate the topic priority. Valid values: very_low, low, default, high, very_high.
issueTypeNoUpdate the topic issue type classification. Valid values: bug_report, feature_request, complaint, praise, or null to clear.
archivedReasonNoOptional reason for archiving. Only used when archived=true.
lifecycleStateNoUpdate the topic lifecycle state. Valid values: open, in_progress, completed, dismissed. The unknown state is AI-assessed and cannot be set directly.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already provide the safety profile (readOnlyHint=false, destructiveHint=true, idempotentHint=true), so the description does not need to repeat those. It adds a non-annotation requirement: reading the 'write-tools' skill before first use. This is useful behavioral context beyond annotations, though it does not detail what destructive effects occur (e.g., whether archived status is reversible).

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?

The description is two terse sentences: the first captures the purpose and field scope, the second gives a critical prerequisite. There is no redundant filler, and the core action is 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 mutation tool with 7 parameters and a detailed schema, the description covers the purpose, the fields, and a required skill check. There is no output schema, so return-value behavior is not explained, but that is a minor gap given the schema's richness and the annotations covering side effects.

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 86%, so the schema's per-parameter descriptions carry most of the meaning. The tool description merely lists the parameter names (priority, lifecycle state, etc.) without adding new semantics, format details, or cross-parameter constraints beyond what the schema already documents.

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?

The description clearly states the action ('Update') and resource ('a single topic'), and enumerates the specific fields (priority, lifecycle state, archived status, issue type, keywords). It distinguishes from siblings by explicitly noting 'single', which contrasts with bulk_update_topics, and the field list separates it from merge_topics.

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 gives clear context: it updates a single topic and lists which attributes can be changed. It also provides a prerequisite ('Before your first call, read the skill: modem_skills(...)'). However, it does not explicitly name alternatives like bulk_update_topics for multiple topics or update_people for other resources, so it stops short of full when/when-not guidance.

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