Skip to main content
Glama
bezata

kObsidian MCP

by bezata

Parse Canvas

canvas.parse
Read-onlyIdempotent

Parse an Obsidian canvas file to extract its complete node and edge structure, including text, file, link, and group nodes. Use this to get the full graph of a canvas.

Instructions

Parse an Obsidian canvas file and return its full structure: every node (text, file, link, group) and every edge. Use this when you need the complete graph; for just the neighbours of a specific node, call canvas.connections instead. Read-only.

Operates on the session-active vault (see vault.current — selectable via vault.select) unless an explicit vaultPath argument is passed, which always wins.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filePathYesVault-relative path to an Obsidian `.canvas` file.
vaultPathNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
edgesYes
nodesYes
filePathYes

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed2 schema fields changedv0.3.5
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. Changed6 schema fields changedv0.1.2
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / filePath / description
      Added value: +"Vault-relative path to an Obsidian `.canvas` file."
    • addedOutput schema / properties / edges
      Added value: +{
      +  "items": {
      +    "additionalProperties": {},
      +    "propertyNames": {
      +      "type": "string"
      +    },
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / filePath
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / nodes
      Added value: +{
      +  "items": {
      +    "additionalProperties": {},
      +    "propertyNames": {
      +      "type": "string"
      +    },
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / required
      Added value: +[
      +  "filePath",
      +  "nodes",
      +  "edges"
      +]
  3. First observedv0.1.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds valuable behavioral context beyond annotations: it explains the session-active vault resolution and that an explicit vaultPath always wins, which is important for correct invocation.

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?

The description is compact and front-loaded: the purpose, output, and primary alternative appear in the first two sentences. The vault-targeting note is the only additional context and is directly relevant to usage. No sentence is wasted.

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?

With an output schema present, return-value details are handled structurally. The description covers the tool's purpose, when to use it, the alternative tool, and the vault resolution rule. It is complete for a read-only parsing tool, though it does not mention error behavior for invalid canvas files, which is a minor gap.

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 50%: filePath is documented but vaultPath has no schema description. The description compensates by explaining vaultPath's role and precedence over the active vault, giving the agent enough semantics to use it correctly. It does not detail vaultPath's format, but the core meaning is clear.

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?

The description states a specific verb ('Parse'), a specific resource ('Obsidian canvas file'), and the exact output scope ('full structure: every node ... every edge'). It also explicitly contrasts itself with canvas.connections, so an agent can distinguish it from its closest sibling without opening schemas.

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?

The description gives an explicit usage rule: use this tool for the complete graph, and use canvas.connections for neighbours of a specific node. It also clarifies the vault-targeting behavior and references vault.current and vault.select, providing clear context for when this tool applies.

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

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/bezata/kObsidian'

If you have feedback or need assistance with the MCP directory API, please join our Discord server