Skip to main content
Glama

ZeroRank - Track and improve your AI search visibility

update_topic

Idempotent

Rename a topic. Renaming to another topic's name fails with CONFLICT.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe topic ID
nameNoNew topic name
workspaceIdYesWorkspace ID — get the list from the list_workspaces tool

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare the safety profile (readOnlyHint=false, idempotentHint=true, destructiveHint=false), so the bar is lower, and the description still adds genuinely useful behavior: a duplicate-name rename fails with CONFLICT, which implies name uniqueness per workspace. It does not mention permission requirements or what happens on success, keeping it 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 short sentences with zero filler, and the core action is front-loaded before the failure-mode detail. Every sentence earns its place.

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 three-parameter mutation with full schema coverage and no output schema, the description covers the action and the notable error case. The only gap is the absence of permission/precondition context, which is minor given the annotations already flag this as a non-destructive, idempotent write.

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 id, name, and workspaceId are already documented (including the pointer to list_workspaces). The description adds no parameter-level detail beyond what the schema provides, 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?

"Rename a topic" gives a specific verb and resource, and it accurately scopes the tool to the only mutable field (name) rather than the broader name update_topic. It does not explicitly contrast itself with sibling update_* tools, but the resource is unambiguous enough that an agent can distinguish it.

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 statement of when to reach for this tool versus list_topics, create_topic, or delete_topic, nor any prerequisite beyond the schema's mention of list_workspaces. Usage is only implied by the verb 'rename'.

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