Skip to main content
Glama

Heystack

Suggest an edit

suggest_edit

Suggest a Markdown or spreadsheet change for the owner to review. New Markdown must be 24,000 bytes or smaller. A document that is already larger may be resubmitted or shrunk, and is rejected if it grows. Sign action "propose" with {documentId, baseRevisionId, content:{kind:"markdown", markdown}, message?}.

Input Schema

NameRequiredDescriptionDefault
kindYes
nonceYes
messageNo
markdownYes
publicKeyYes
signatureYes
timestampYes
documentIdYes
baseRevisionIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.7/5.0
Behavior2/5

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

Since there are no annotations, the description bears the full burden. It successfully adds behavioral constraints (size limits), but it fails to describe the nature of the 'propose' action—is it immediate, does it trigger alerts, or what is the expected status of the document afterward? The required cryptographic parameters are not explained.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The definition is relatively concise, though its first sentence mixes the purpose with the deliverable format. The structure is logical, though it could benefit from separating the 'what it does' from the 'how it is limited' constraints.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the high complexity (8 required parameters, crypto involved) and the extremely low schema description coverage, the definition is highly incomplete. An agent cannot reliably fulfill the request without external documentation explaining the required technical fields.

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

Parameters1/5

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

With 0% schema description coverage, the description provides almost no semantic value beyond listing the final required structure for signing. It does not explain the purpose of the required metadata or cryptographic parameters (like 'nonce' or 'signature'), which are critical for an agent understanding how to construct the payload.

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 clearly states the core purpose: suggesting a change for review. It specifies the supported mediums (Markdown or spreadsheet), successfully distinguishing it from direct editing tools like 'edit_markdown'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It provides crucial constraints regarding document size (24,000 bytes) and revision integrity (rejected if the document grows), which serves as a guideline. However, it does not explicitly state the workflow trigger or when this tool is preferred over other contribution methods.

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