Skip to main content
Glama

Update Load Test Notes

update_load_test_notes
DestructiveIdempotent

Replace the notes on a finished Load Test's Test Report — the only writable thing on a Load Test. Ask the user before writing: notes belong to the user, and advising on a test never requires writing them. The text sent becomes the report's entire notes, so first read the current notes with get_load_test_report and preserve the user's content in what you send.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
notesYesThe full notes text to store on the Test Report, replacing whatever notes it already carries. At most 4096 characters; an empty string clears the notes.
testIdYesThe load test id, as reported by list_load_tests.
projectIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior4/5

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

The description matches the annotations: destructiveHint=true and readOnlyHint=false, and idempotentHint=true is consistent with a replace operation. Beyond the annotations, it discloses that the tool is the only writable field on a Load Test, that it overwrites the entire notes, and that an empty string clears notes. Minor gap: it doesn't mention potential effects on other users or restore/versioning, but it adds substantial context.

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 three sentences, front-loads the core behavior, and every sentence earns its place. It covers the action, the guardrail, and the overwrite caveat without fluff.

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?

Given no output schema and three required parameters, the description addresses the critical operational context: when to write, what to preserve, and the full-replacement behavior. The sibling list and annotations cover the rest, so an agent has enough to invoke it correctly.

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 67% and the description adds meaningful semantics beyond the schema: it emphasizes that notes replaces the entire report notes, advises reading current notes first to preserve content, and clarifies the user-ownership aspect. This goes beyond the schema's basic parameter descriptions.

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 tool's specific verb and resource: it replaces the notes on a Load Test's Test Report, emphasizing that it is the only writable thing on a Load Test. This distinguishes it from all sibling update tools and get_load_test_report.

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?

It gives explicit when-to-use guidance: ask the user before writing, never write when merely advising on a test. It also directs the agent to first read the current notes with get_load_test_report and preserve the user's content, and warns that the text sent becomes the entire notes.

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.