Skip to main content
Glama

Update research brief

update_research_brief
DestructiveIdempotent

Revises a research brief already saved via ingest_research_brief — replaces its content in place (id unchanged; pass title to rename it too), visible in the dashboard and used as context by generate_strategy/generate_campaign from then on. Pass an empty string as content to retire a stale brief (clear it) while keeping its title and id — e.g. a worked-examples or knowledge brief whose seed content needs replacing. No delete tool exists; emptying content is the retirement path.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleNoOptional new title. Omit to keep the current one. The system-maintained briefs ("Knowledge — <brand>", "Approved posts — worked examples") can't be renamed — they are found by title.
brandIdYesThe brand's id, from list_brands.
briefIdYesThe research brief's id — from list_research_briefs, or a prior ingest_research_brief result.
contentYesThe brief's new content, replacing what's there now, in full — saved verbatim. Pass an empty string to clear a brief's content while keeping its title and id (e.g. retiring a stale worked-examples seed).
sourceNoteNoOptional short note on why this was updated, e.g. "retired the seed exemplars — see step 17".

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations declare destructiveHint=true and idempotentHint=true; the description goes well beyond that by disclosing that content is replaced in full and verbatim, the id is unchanged, the brief is visible in the dashboard and consumed as context by generate_strategy/generate_campaign, and that no delete tool exists so emptying content is the only retirement path. That is exactly the behavioral context annotations cannot convey.

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-loaded with the core action and lifecycle consequences, and every sentence carries information. It is somewhat dense and repeats the empty-string retirement rule that the content parameter schema already states, which is a small redundancy.

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?

No output schema exists, and the description covers what an agent needs for a destructive mutation: downstream consumers of the brief, the rename constraint, the retirement pattern, and the absence of a delete alternative. Nothing material is missing.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds cross-parameter meaning the schema only implies: briefId is preserved on update, title is the rename lever, and empty content is a semantic state (retired) rather than mere emptiness. It largely reinforces schema text (the empty-string rule appears in both), so it does not reach 5.

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 (revises a research brief) and pins down its scope immediately: 'already saved via ingest_research_brief — replaces its content in place (id unchanged)'. This clearly separates it from ingest_research_brief, generate_knowledge_brief, and get_brand_brief without needing to open any schema.

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?

Explicitly tells the agent when to reach for this tool (revising an existing brief, renaming via title) and gives the non-obvious alternative path for retirement: 'Pass an empty string as content to retire a stale brief... No delete tool exists; emptying content is the retirement path.' When/when-not guidance is complete.

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.