hedgedoc-mcp

hedgedoc_note_info

Read-only

Retrieve metadata for a HedgeDoc note, including title, description, view count, and creation/update timestamps. Use it to check note details before reading or editing.

Instructions

Get metadata for a note.

Returns JSON with: 'title' (string), 'description' (string or null), 'viewcount' (integer — total views), 'createtime' and 'updatetime' (ISO 8601 timestamps, e.g. '2026-08-16T10:30:00.000Z'). Public notes need no authentication.

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": {
      "note_id": "<note_id>"
    },
    "name": "hedgedoc_note_info"
  }
}

Input Schema

Name	Required	Description	Default
`note_id`	Yes	The note's unique ID (e.g. 'AbC123XyZ') or custom alias (e.g. 'my-meeting-notes'). Both forms are accepted.

Schema Changelog

Changes observed during successful MCP inspections.

Changed3 schema fields changedv0.2.0Oct 14, 2026

changedInput schema / properties / note_id / description

Previous value: -"Note ID or alias."New value: +"The note's unique ID (e.g. 'AbC123XyZ') or custom alias (e.g. 'my-meeting-notes'). Both forms are accepted."

addedInput schema / properties / note_id / title
```
Added value: +"Note Id"
```

addedInput schema / title

Added value: +"hedgedoc_note_infoArguments"

First observedv0.1.0Aug 17, 2026

TDQS

A3.6/5.0

Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds meaningful context beyond that: the exact JSON fields returned (title, description, viewcount, createtime, updatetime) and the authentication requirement for non-public notes.

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?

The purpose is front-loaded in one short sentence, followed by the return-field enumeration and the auth note. The field list is somewhat verbose but earns its place because no output schema exists.

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?

With no output schema, the description correctly carries the return-value burden by enumerating all fields and their types. Combined with annotations covering read-only behavior and the auth note for private notes, an agent has what it needs to call this correctly.

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?

Schema description coverage is 100%, and the schema already explains that both a unique ID and a custom alias are accepted. The description adds no parameter detail beyond what the schema provides, so the baseline of 3 applies.

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?

States a specific verb and resource ('Get metadata for a note'), which is clearly distinct from hedgedoc_read_note (content) and hedgedoc_create_note. It does not explicitly name or contrast with those siblings, but the resource scope makes the distinction inferable.

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 statement of when to use this tool versus hedgedoc_read_note or hedgedoc_list_history. The only contextual cue is 'Public notes need no authentication,' which hints at a permission condition but gives no selection guidance or exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server