MCP Server Obsidian Jsoncanvas

🚀 JSON Canvas MCP Server

A server implementing the Model Context Protocol (MCP), providing tools for processing JSON Canvas files compliant with the official specification. This server supports creating, modifying, and validating infinite canvas data structures.

🚀 Quick Start

JSON Canvas MCP Server fully implements the JSON Canvas 1.0 specification and supports the following features:

• Create and manipulate infinite canvas data
• Support all node types (text, file, link, group)
• Edge connections with styles and labels
• Validate against the specification
• Configurable output paths

✨ Features

Resources

The server exposes the following resources:

• canvas://schema: A JSON schema for validating canvas files
• canvas://examples: Example canvas files demonstrating different features
• canvas://templates: Templates for creating new canvases

Tools

Node Operations

• create_node

  • Create a new node of any type
  • Input:
    • type (string): Node type ("text", "file", "link", "group")
    • properties (object): Node-specific properties
      • Common properties: id, x, y, width, height, color
      • Type-specific properties: text, file, url, etc.
  • Returns: The created node object

• update_node

  • Update the properties of an existing node
  • Input:
    • id (string): ID of the node to update
    • properties (object): Properties to update
  • Returns: The updated node object

• delete_node

  • Delete a node and its connected edges
  • Input:
    • id (string): ID of the node to delete
  • Returns: None

Edge Operations

• create_edge

  • Create a new edge
  • Input:
    • id (string): Unique identifier for the edge
    • from_node (string): ID of the starting node
    • to_node (string): ID of the target node
    • Optional properties:
      • label (string): Label for the edge
      • color (string): Color of the edge
      • style (object): Style of the edge
  • Returns: The created edge object

• update_edge

  • Update the properties of an existing edge
  • Input:
    • id (string): ID of the edge to update
    • properties (object): Properties to update
  • Returns: None

• delete_edge

  • Delete an edge
  • Input:
    • id (string): ID of the edge to delete
  • Returns: None

Canvas Operations

• add_node

  • Add a node to the canvas
  • Input:
    • node (object): Node to add
  • Returns: None

• add_edge

  • Add an edge to the canvas
  • Input:
    • edge (object): Edge to add
  • Returns: None

• remove_node

  • Remove a node and its related edges from the canvas
  • Input:
    • id (string): ID of the node to remove
  • Returns: None

• remove_edge

  • Remove an edge from the canvas
  • Input:
    • id (string): ID of the edge to remove
  • Returns: None

• save_canvas

  • Save the current canvas state to a file
  • Input:
    • file_path (string): Path to the file to save
  • Returns: None

📚 Documentation

Integration with Claude Desktop

To use this server in Claude Desktop, you can follow these steps:

1. Install Dependencies: Ensure that all necessary libraries and tools are installed.

2. Start the Server: Start the MCP server using the appropriate command.

3. Connect to Canvas: Select JSON Canvas MCP as the target platform in Claude Desktop.

4. Start Development: Use the provided APIs and tools to create, edit, and save canvases.

Environment Variable Configuration

• CANVAS_PATH: Specify the default canvas file path
• DEBUG_MODE: Enable or disable debug mode
• LOG_LEVEL: Set the logging level ("debug", "info", "warning", "error", "critical")

💻 Usage Examples

Basic Usage

from jsoncanvas import Canvas, TextNode, Edge

# Create nodes
title = TextNode(
    id="title",
    x=100,
    y=100,
    width=400,
    height=100,
    text="# Hello Canvas\n\n这是一个演示。",
    color="#4285F4"
)

info = TextNode(
    id="info",
    x=600,
    y=100,
    width=300,
    height=100,
    text="更多信息在这里",
    color="2"  # Use a preset color
)

# Create a canvas
canvas = Canvas()
canvas.add_node(title)
canvas.add_node(info)

# Connect nodes
edge = Edge(
    id="edge1",
    from_node="title",
    to_node="info",
    from_side="right",
    to_side="left",
    label="连接"
)
canvas.add_edge(edge)

# Save the canvas
canvas.save("example.canvas")

📄 License

This MCP server is distributed under the MIT License. This means you can freely use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please refer to the LICENSE file in the project repository.