Skip to main content
Glama

UpdateProposalDescription

DestructiveIdempotent

Replace the description of a schema proposal, the same action as editing the description in GraphOS Studio. The new text replaces the whole description, so to add to it, read the current description with GetProposal and send the full text. GraphOS rejects a description longer than 10,000 characters with a ValidationError. Returns the proposal's ID and new description, or an error with a message. Provide the graph ID, the proposal variant name from GetProposal, and the new description.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "graphId": "<graphId>",
      "proposalVariant": "<proposalVariant>",
      "description": "<description>"
    },
    "name": "UpdateProposalDescription"
  }
}

Input Schema

NameRequiredDescriptionDefault
graphIdYes
descriptionYes
proposalVariantYes

Output Schema

NameRequiredDescriptionDefault
dataNo
errorsNo
extensionsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=true, idempotentHint=true, so the safety profile is covered; the description still adds real value by disclosing that the whole description is replaced (not appended), the 10,000-character limit and its error type, and what is returned. The lower score reflects that these are the main additions and it does not discuss permissions or failure modes beyond validation.

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?

Five short sentences, front-loaded with the action and the replacement semantics. The closing sentence partially restates the parameters already implied earlier, so it is efficient but not maximally tight.

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?

For a three-parameter mutation with an output schema already defining the return shape, the description covers the behavioral essentials: replacement semantics, source of proposalVariant, size limit, and error signaling. Nothing an agent needs to invoke it correctly 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 0%, so the description must carry the burden; it names all three inputs and adds the key provenance detail that proposalVariant comes from GetProposal, and that description is the full replacement text. It stops short of specifying the graphId format (e.g. graph@variant), leaving one input's syntax to inference.

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: 'Replace the description of a schema proposal', and anchors it to a familiar equivalent ('the same action as editing the description in GraphOS Studio'). It distinguishes itself from the read path by naming GetProposal as the way to read the current text, so an agent can separate it from GetProposal or UpdateProposalTitle without opening a 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 this tool is wrong for a partial edit: to add to a description, read the current value with GetProposal and send the full text instead. It also describes the rejection condition (over 10,000 characters -> ValidationError) that determines whether a call can succeed.

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