Skip to main content
Glama

Update Topic

update_topic
Destructive

Edit one research Topic by topicId from list_sites_and_topics. Read get_topic and get_scan_config first. Omission preserves values; null clears description or focalEntityId. strategicGoal sets/replaces the strategy note, or null clears it. models applies explicit on/off edits, preserving unspecified models; null clears all selections. Goal or models can be the only edit. Model edits are checked against the plan and do not launch a scan. topicProfile replaces the complete scope profile. A focalEntityId must be an existing tracked entity in this Topic; it is independent of Client association. Clear focus before removing its entity. Brand Site IDs and brand profile fields are refused. At least one effective edit is required. Edits to an archived Topic are refused with site_archived; use archive_topic for retirement. Returns site metadata and scanConfig with the saved Topic context, focus, tracked entities and current configuration. The site response field is retained for compatibility; shared tools use its id as siteId. Does not launch a scan or rewrite scan history.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNo
modelsNoModel on/off edits. Unspecified models are preserved; null clears all selections. Creation patches account defaults only for a new configuration; retries preserve saved models. IDs are listed in this schema and get_scan_config. Plan access is checked per model when enabling.
topicIdYes
descriptionNo
topicProfileNo
focalEntityIdNo
strategicGoalNoOptional strategy note: only objective, trimmed 1–2000 Unicode characters. Omission preserves it; null clears on update. Creation initializes an absent note and preserves a saved note.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
siteYes
summaryYes
scanConfigYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.9/5.0
Behavior5/5

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

Goes well beyond the destructiveHint=true annotation: it discloses omission-vs-null semantics per field, that at least one effective edit is required, refusal behaviors (site_archived, brand fields refused), validation constraints on focalEntityId, and that no scan is launched or history rewritten.

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?

Front-loads the core purpose and every sentence carries real semantic content, but the density is high and a few clauses (e.g. the site-field compatibility remark) could be tightened without loss.

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

Completeness5/5

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

Despite an output schema existing, the description still orients the agent on the return shape (site metadata plus scanConfig with context, focus, tracked entities and config) and covers refusals and invariants, leaving nothing needed to call it correctly.

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

Parameters5/5

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

With only 29% schema description coverage, the description compensates thoroughly: it explains preservation vs clearing for description, focalEntityId, strategicGoal and models, the replace semantics of topicProfile, and the plan check for model edits.

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 and resource ('Edit one research Topic by topicId from list_sites_and_topics') and anchors the entity source, so it is clearly distinguishable from create_topic, get_topic and archive_topic.

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?

Gives explicit prerequisites ('Read get_topic and get_scan_config first'), states the alternative for the retirement case ('use archive_topic for retirement'), and clarifies that model edits don't launch a scan. When/when-not and alternatives are all present.

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