Skip to main content
Glama

Review or rewrite reference note

studio_reference_note_update
DestructiveIdempotent

Approve, reject or rewrite one reference note using the app service. Rewriting records the sentence as user-authored; omitted fields stay unchanged. Returns the updated fact. Requires permission to edit its project and the customer choosing the change. No server interpretation or paid work starts.

Input Schema

NameRequiredDescriptionDefault
factIdYesFact ID returned by studio_reference_notes_list.
statusNoCustomer review choice for this fact.
projectIdYesProject ID returned by studio_projects_list or studio_video_start.
statementNoReplacement sentence approved by the customer.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Beyond the annotations, the description discloses useful behavior: rewriting records the sentence as user-authored, omitted fields stay unchanged (partial-update semantics), the call requires edit permission and customer consent, and it triggers no server interpretation or paid work. This adds meaningful context on top of the destructive/idempotent hints.

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?

Four short sentences, front-loaded with the action and followed by effects, return value, preconditions and cost. Every sentence carries information, though the final clause about no server interpretation reads slightly out of 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?

With an output schema present, the description need not explain return values, and it covers action, side effects, partial-update behavior and permissions. It is essentially complete for an agent to invoke this mutation correctly.

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 the schema already documents factId, status, projectId and statement with sources and constraints. The description matches the fields functionally but adds no syntax or format detail beyond what the schema provides, so the baseline of 3 applies.

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 states specific verbs (approve, reject, rewrite) and a precise resource (one reference note), so an agent knows exactly what the tool does. It does not, however, differentiate itself from closely named siblings like studio_reference_note_add or studio_reference_notes_list.

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?

It states the preconditions for correct use: edit permission on the project and the customer having chosen the change. This clarifies the context of invocation but names no alternative tool or explicit when-not-to-use case.

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