JSON Canvas

🚀 JSON Canvas MCP 服務器

JSON Canvas MCP 服務器是一個實現了 Model Context Protocol (MCP) 協議的服務器，它依據 官方規範，提供了用於處理 JSON Canvas 文件的工具。該服務器支持創建、修改和驗證無限畫布數據結構，為用戶在畫布操作方面提供了強大的功能支持。

🚀 快速開始

克隆倉庫

使用 Git 克隆此項目：

git clone https://github.com/your-username/jsoncanvas.git
cd jsoncanvas

安裝依賴

運行以下命令安裝所需依賴項：

pip install -r requirements.txt

運行服務器

安裝完成後，運行以下命令啟動服務器：

python3 -m jsoncanvas.server

✨ 主要特性

JSON Canvas MCP 服務器完整實現了 JSON Canvas 1.0 規範，具備以下強大功能：

• 數據操作：支持創建和操作無限畫布數據，滿足多樣化的畫布使用需求。
• 節點類型豐富：支持所有節點類型，包括文本、文件、鏈接、組，為畫布內容的構建提供了多種選擇。
• 邊連接及標籤：提供帶樣式的邊連接及標籤，使畫布元素之間的關係更加清晰。
• 規範驗證：可對規範進行驗證，確保畫布數據的準確性和規範性。
• 輸出路徑可配置：用戶能夠根據自身需求配置輸出路徑。

📦 安裝指南

環境變量配置

設置以下環境變量以自定義服務器行為：

• JSONCANVAS_PORT：指定服務器監聽的端口，默認為 3000。
• JSONCANVAS_HOST：指定服務器綁定的主機地址，默認為 localhost。
• JSONCANVAS_LOG_LEVEL：指定日誌級別，可選值有 debug, info, warning, error，默認為 info。

配置文件

可以在項目根目錄下創建一個 config.json 文件：

{
  "port": 3001,
  "host": "127.0.0.1",
  "log_level": "debug"
}

💻 使用示例

基礎用法

使用 Claude Desktop 的方式一：通過命令行工具

1. 安裝並啟動 Claude Desktop。
2. 打開終端，運行以下命令：

python3 -m jsoncanvas.example

3. 按照提示操作即可。

使用 Claude Desktop 的方式二：直接使用 API 接口

from jsoncanvas import Canvas, TextNode, Edge

# 創建節點
title = TextNode(
    id="title",
    x=100,
    y=100,
    width=400,
    height=100,
    text="# Hello Canvas\n\nThis is a demonstration.",
    color="#4285F4"
)

info = TextNode(
    id="info",
    x=600,
    y=100,
    width=300,
    height=100,
    text="More information here",
    color="2"  # 使用預設顏色
)

# 創建畫布
canvas = Canvas()
canvas.add_node(title)
canvas.add_node(info)

# 連接節點
edge = Edge(
    id="edge1",
    from_node="title",
    to_node="info",
    from_side="right",
    to_side="left",
    label="Connection"
)
canvas.add_edge(edge)

# 保存畫布
canvas.save("example.canvas")

高級用法

創建一個畫布

from jsoncanvas import Canvas, TextNode, Edge

# 創建節點
title = TextNode(
    id="title",
    x=100,
    y=100,
    width=400,
    height=100,
    text="# Hello Canvas\n\nThis is a demonstration.",
    color="#4285F4"
)

info = TextNode(
    id="info",
    x=600,
    y=100,
    width=300,
    height=100,
    text="More information here",
    color="2"  # 使用預設顏色
)

# 創建畫布
canvas = Canvas()
canvas.add_node(title)
canvas.add_node(info)

# 連接節點
edge = Edge(
    id="edge1",
    from_node="title",
    to_node="info",
    from_side="right",
    to_side="left",
    label="Connection"
)
canvas.add_edge(edge)

# 保存畫布
canvas.save("example.canvas")

📚 詳細文檔

組件

資源

服務器公開了以下資源：

• canvas://schema：用於驗證畫布文件的 JSON 模式。
• canvas://examples：演示不同功能的示例畫布文件。
• canvas://templates：創建新畫布的模板。

工具

節點操作

• create_node

  • 功能：創建任意類型的新節點。
  • 輸入：
    • type (字符串)：節點類型 ("text", "file", "link", "group")。
    • properties (對象)：節點特定屬性。
      • 公共屬性：id, x, y, width, height, color。
      • 類型特定屬性：text, file, url 等。
  • 返回：創建的節點對象。

• update_node

  • 功能：更新現有節點屬性。
  • 輸入：
    • id (字符串)：要更新的節點 ID。
    • properties (對象)：要更新的屬性。
  • 返回：已更新的節點對象。

• delete_node

  • 功能：刪除節點及其連接的邊。
  • 輸入：
    • id (字符串)：要刪除的節點 ID。
  • 返回：無。

邊操作

• create_edge

  • 功能：創建新邊。
  • 輸入：
    • id (字符串)：邊的唯一標識符。
    • from_node (字符串)：起始節點的 ID。
    • to_node (字符串)：目標節點的 ID。
    • label (字符串，可選)：邊的標籤。
    • color (字符串，可選)：邊的顏色，默認為 "#000000"。
  • 返回：創建的邊對象。

• update_edge

  • 功能：更新現有邊屬性。
  • 輸入：
    • id (字符串)：要更新的邊 ID。
    • properties (對象)：要更新的屬性。
  • 返回：無。

• delete_edge

  • 功能：刪除指定邊。
  • 輸入：
    • id (字符串)：要刪除的邊 ID。
  • 返回：無。

📄 許可證

此項目採用 MIT 許可證。詳見 LICENSE 文件。