Skip to main content
Glama

read_note

Returns a wiki note's full content by note ID, including frontmatter metadata, body text, and in/out link lists for context.

Instructions

특정 wiki 노트의 전체 내용 읽기.

Args: note_id: 노트 ID (예: "mcp-server-development", "prompt-xml-tags")

Returns: 프론트매터 메타 + 본문 + in/out link 목록

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": "read_note"
  }
}

Input Schema

NameRequiredDescriptionDefault
note_idYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.0

TDQS

A3.5/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full behavioral burden. It does disclose the shape of the result (frontmatter metadata + body + in/out link lists) and the read-only nature is implicit in '읽기', but nothing is said about what happens when the note does not exist, whether access is scoped, or how large notes are handled.

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

Conciseness5/5

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

One-line purpose followed by Args and Returns blocks; every line carries information, and the purpose is front-loaded. Nothing is padded, and the return summary is brief enough not to duplicate the output schema at length.

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

Completeness4/5

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

For a one-parameter read tool with an output schema present, the definition covers purpose, argument format, and return composition. The remaining gap is failure-mode behavior (unknown note_id), which matters more here than return-value documentation since the output schema already describes results.

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% — note_id is documented nowhere in the schema — so the description must compensate, and it does with two concrete slug-format examples ('mcp-server-development', 'prompt-xml-tags'). That tells the agent what kind of identifier to construct, which is the key risk for this parameter.

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 gives a specific verb and resource — reading the FULL content of a specific wiki note — which distinguishes it from a search-style sibling by making clear it is an ID-addressed full-body retrieval. It stops short of naming a contrasting sibling (e.g. search_wiki) explicitly, so an agent must infer the boundary.

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 versus search_wiki, list_domains, or find_related, and no prerequisite such as 'you need a note_id obtained from search_wiki'. The only hint is that the single arg is a note ID, which implicitly means ID-addressed lookup rather than discovery.

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