Skip to main content
Glama

Edit your Markdown Document

heystack_edit_markdown
Destructive

Edit your Markdown Document. Requires MCP 2026-07-28.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "heystack_edit_markdown"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

C2.2/5.0
Behavior2/5

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

Annotations already declare destructiveHint=true, readOnlyHint=false and idempotentHint=false, so the safety profile is known; the description adds nothing about what a destructive edit overwrites, whether it is reversible, or how edits are expressed. The only extra sentence, "Requires MCP 2026-07-28," is a protocol-version note that gives the caller no behavioral information and could be mistaken for a client prerequisite.

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?

At two short sentences it is certainly concise and front-loaded, but the size reflects under-specification rather than economy. The second sentence about the MCP version is the only added content and does not help an agent decide or invoke.

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

Completeness1/5

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

For a destructive mutation tool with no output schema, no parameters, and no explanatory description, an agent has essentially nothing to work with. It cannot know what document is edited, what content is sent, or what the result looks like — the definition is inadequate for the tool's complexity.

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?

The input schema declares zero properties, so there is no parameter documentation to add to and the baseline would be a 4. However, an edit tool with an empty parameter object is unusual, and the description offers no hint about how the document content or target is supplied, leaving the calling convention opaque.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose2/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description "Edit your Markdown Document" restates the tool name and title almost verbatim, adding no scope beyond the words already present in the identifier. It does not say what an 'edit' covers (text, title, structure), nor distinguish this from heystack_suggest_edit or heystack_create_markdown.

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

Usage Guidelines2/5

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

There is no when-to-use or when-not-to-use guidance. An agent cannot tell from this text whether to call this tool directly versus heystack_suggest_edit (propose changes for review) or heystack_create_markdown, nor what prerequisites a document edit requires.

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