Skip to main content
Glama

Save validation research edits

validation.save_workspace
Idempotent

Save partial seven-section edits or TAM/SAM/SOM estimates into the web editor's document. Read validation.get_project first and pass its workspace.expected_updated_at exactly (including null). documents accepts version-1 rich doc nodes copied from the read; section_text accepts plain text, one format per section. Untouched sections and legacy fields remain. Plain text/metrics default to AI provenance; use text_origin=user only for user-authored content. Rich text carries its own aiGenerated marks. Stale or busy documents reject the write. Use a stable idempotency key and read back after an interrupted response.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
documentsNo
project_idYes
text_originNoai
section_textNo
market_sizingNo
idempotency_keyNo
expected_updated_atYes
validation_project_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond annotations: discloses that stale/busy documents reject the write (concurrency/optimistic-locking behavior), that untouched sections and legacy fields remain, and that plain text/metrics default to AI provenance while rich text carries its own aiGenerated marks. This is meaningful context the structured fields don't 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-loads the purpose before workflow and constraint details, and each sentence carries operational information. It is dense and long but almost nothing is filler.

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?

An output schema exists so return values need no explanation; the description covers the prerequisites, write semantics, provenance rules, concurrency failure mode, and recovery guidance. An agent has everything needed 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?

Despite 0% schema description coverage, the description explains the important parameters: documents (version-1 rich nodes copied from the read), section_text (plain text, one format per section), text_origin semantics, expected_updated_at (must match exactly, including null), and idempotency_key. project_id/validation_project_id and the market_sizing structure get less explicit treatment.

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 (save) and resource (validation research workspace edits), scoping it to the seven-section document and TAM/SAM/SOM estimates. This clearly distinguishes it from siblings like validation.regenerate_section and validation.export_document.

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?

Names the prerequisite sibling (read validation.get_project first) and tells the agent to pass expected_updated_at exactly, plus how to pick text_origin. It gives strong context but doesn't explicitly contrast with alternatives such as regenerate_section or open_workspace.

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