思源笔记MCP

ZHiZhi01/SiYuanMCPServer
8 Stars 468 次浏览 更新于 2026-08-23

| --- 一个为思源笔记提供的模型上下文协议(MCP)服务器,提供完整的思源API功能。1. 打开光标设置 (Ctrl/Cmd + ,) 2. 搜索 "MCP" 或 "模型上下文协议" 3.

MCP 服务配置

复制以下 JSON 到 OPClaw 或其他 MCP 客户端的配置文件中即可使用

{
  "mcpServers": {
    "siyuan-mcp": {
      "args": [
        "run",
        "--rm",
        "-e",
        "SIYUAN_HOST=127.0.0.1",
        "-e",
        "SIYUAN_PORT=6806",
        "-e",
        "SIYUAN_TOKEN=your-api-token-here",
        "zhizhiqq/siyuan-mcp:latest"
      ],
      "command": "docker",
      "env": {}
    }
  }
}

该服务需要配置环境变量:SIYUAN_HOST、SIYUAN_PORT、SIYUAN_TOKEN

服务介绍

思源笔记 MCP 服务器 / SiYuan MCP Server

English | 中文


中文版本

为思源笔记提供一个模型上下文协议(MCP)服务器,提供完整的思源 API 功能。

🚀 快速开始

使用 npx(推荐)

# Run directly
npx -y siyuan-mcp@latest

# Set environment variables
SIYUAN_HOST=127.0.0.1 SIYUAN_PORT=6806 SIYUAN_TOKEN=your-token npx -y siyuan-mcp@latest

使用 Docker

# Pull image
docker pull zhizhiqq/siyuan-mcp:latest

# Run container
docker run -d \
  -e SIYUAN_HOST=127.0.0.1 \
  -e SIYUAN_PORT=6806 \
  -e SIYUAN_TOKEN=your-token \
  --name siyuan-mcp-server \
  zhizhiqq/siyuan-mcp:latest

配置 MCP 客户端

Cursor 配置
  1. 打开 Cursor 设置(Ctrl/Cmd + ,)
  2. 搜索 "MCP" 或 "模型上下文协议"
  3. 点击 "添加服务器" 或 "添加服务器"
  4. 配置服务器信息:
{
  "mcpServers": {
    "siyuan-mcp": {
      "command": "npx",
      "args": ["-y", "siyuan-mcp@latest"],
      "env": {
        "SIYUAN_HOST": "127.0.0.1",
        "SIYUAN_PORT": "6806",
        "SIYUAN_TOKEN": "your-api-token-here"
      }
    }
  }
}
Claude Desktop 配置
  1. 打开 Claude Desktop 设置
  2. 转到 "模型上下文协议" 设置
  3. 添加新的 MCP 服务器:
{
  "mcpServers": {
    "siyuan-mcp": {
      "command": "npx",
      "args": ["-y", "siyuan-mcp@latest"],
      "env": {
        "SIYUAN_HOST": "127.0.0.1",
        "SIYUAN_PORT": "6806",
        "SIYUAN_TOKEN": "your-api-token-here"
      }
    }
  }
}
Docker 配置

如果您使用 Docker 运行服务,可以配置客户端连接到 Docker 容器:

Cursor Docker 配置

{
  "mcpServers": {
    "siyuan-mcp": {
      "command": "docker",
      "args": ["run", "--rm", "-e", "SIYUAN_HOST=127.0.0.1", "-e", "SIYUAN_PORT=6806", "-e", "SIYUAN_TOKEN=your-api-token-here", "zhizhiqq/siyuan-mcp:latest"],
      "env": {}
    }
  }
}

Claude Desktop Docker 配置

{
  "mcpServers": {
    "siyuan-mcp": {
      "command": "docker",
      "args": ["run", "--rm", "-e", "SIYUAN_HOST=127.0.0.1", "-e", "SIYUAN_PORT=6806", "-e", "SIYUAN_TOKEN=your-api-token-here", "zhizhiqq/siyuan-mcp:latest"],
      "env": {}
    }
  }
}

注意:在使用 Docker 配置时,请确保已安装并运行 Docker。

🔧 环境变量

变量 描述 默认值 是否必需
SIYUAN_HOST 思源服务器地址 127.0.0.1
SIYUAN_PORT 思源服务器端口 6806
SIYUAN_TOKEN API 令牌 -

📋 常见问题

Q: 如果连接失败怎么办?

A: 请检查以下步骤:

  1. 确保思源笔记正在运行
  2. 检查 API 令牌是否正确
  3. 确认思源笔记中有打开的笔记本
  4. 重启思源笔记和 Cursor

Q: 如何获取正确的 API 令牌?

A:

  1. 打开思源笔记
  2. 转到 设置关于API 令牌
  3. 点击 生成令牌 或复制现有令牌
  4. 确保证书格式正确(通常是一串字母数字字符)

Q: 为什么在 npx 中使用 -y 参数?

A: -y 参数会自动确认包的安装而无需用户输入,这对于 MCP 客户端配置非常重要,因为交互式提示会导致连接失败。

🎯 功能

📚 笔记本管理

笔记本是思源笔记的基本组织单元,每个笔记本包含多个文档。

  • list_notebooks - 列出所有笔记本,获取笔记本 ID 和名称
  • open_notebook - 打开指定笔记本,激活工作区
  • close_notebook - 关闭指定笔记本,释放资源
  • rename_notebook - 重命名笔记本,更新显示名称
  • create_notebook - 创建新笔记本,支持自定义名称
  • remove_notebook - 删除笔记本,清理相关数据
  • get_notebook_conf - 获取笔记本配置信息
  • set_notebook_conf - 保存笔记本配置,自定义设置

📄 文档管理

文档是笔记本中的特定内容单元,支持层次结构和路径管理。

  • create_doc - 在指定笔记本中创建新文档,支持 Markdown 内容
  • rename_doc - 重命名文档,保持内容不变
  • rename_doc_by_id - 通过文档 ID 重命名,精确操作
  • remove_doc - 删除文档,清理文件系统
  • remove_doc_by_id - 通过文档 ID 删除,精确操作
  • move_docs - 将文档移动到其他位置或笔记本
  • move_docs_by_id - 通过文档 ID 移动,精确操作
  • get_hpath_by_path - 通过路径获取可读路径
  • get_hpath_by_id - 通过 ID 获取可读路径
  • get_path_by_id - 通过 ID 获取存储路径
  • get_ids_by_hpath - 通过可读路径获取 ID

🧩 块操作

块是思源笔记中的最小内容单元,支持灵活编辑、重组和引用。

  • insert_block - 插入块,支持指定位置和数据类型
  • prepend_block - 插入前置子块,在父块开头添加内容- append_block - 插入子块,在父块末尾添加内容
  • update_block - 更新块内容,支持 Markdown 和 DOM 格式
  • delete_block - 删除块,清理相关引用
  • move_block - 移动块到新位置,支持层级调整
  • get_block_kramdown - 获取块的 kramdown 源代码,用于导出
  • get_child_blocks - 获取子块列表,遍历块结构
  • fold_block - 折叠块,隐藏子内容
  • unfold_block - 展开块,显示子内容
  • transfer_block_ref - 转移块引用,维护引用关系

🏷️ 属性操作

块属性用于存储元数据和自定义信息,支持键值对存储。

  • set_block_attrs - 设置块属性,支持自定义键值对
  • get_block_attrs - 获取块属性,读取元数据信息

🔍 搜索和查询

通过 SQL 查询从思源笔记中获取数据,支持复杂的查询条件。

  • sql_query - 执行 SQL 查询,支持所有 SQLite 语法
  • flush_transaction - 提交事务,确保数据持久化

📁 文件操作

管理思源笔记工作区中的文件和目录,支持资源管理。

  • get_file - 获取文件内容,读取文件数据
  • remove_file - 删除文件,清理存储空间
  • rename_file - 重命名文件,更新文件路径
  • read_dir - 列出目录内容,浏览文件结构
  • put_file - 写入文件,创建或更新文件内容

📤 导出功能

将思源笔记内容导出为各种格式,支持备份和分享。

  • export_md_content - 导出 Markdown 文本,保持格式
  • export_resources - 导出文件和目录,包括资源文件

📢 通知功能

向用户推送消息和错误提示,提供操作反馈。

  • push_msg - 推送消息,显示成功提示
  • push_err_msg - 推送错误消息,显示错误信息

💻 系统信息

获取思源笔记系统状态和运行时信息,监控系统健康状况。

  • get_version - 获取思源笔记版本信息
  • get_current_time - 获取系统当前时间
  • get_boot_progress - 获取启动进度,监控启动状态
  • check_siyuan_status - 检查思源笔记状态和 API 可用性
  • get_workspace_info - 获取工作区和连接信息

🎨 模板功能

使用模板系统创建动态内容,支持变量替换。

  • render_template - 渲染模板文件,支持外部模板
  • render_sprig - 渲染 Sprig 模板,支持内联模板语法

🔄 转换功能

使用 Pandoc 进行文档格式转换,支持多种输出格式。

  • pandoc_convert - Pandoc 转换,支持多种文档格式

📎 资源文件

管理思源笔记中的资源文件,支持批量上传。

  • upload_asset - 上传资源文件,支持批量操作

🔧 核心特性

🚀 高性能

  • 异步处理:所有 API 调用均使用异步处理以加快响应速度
  • 批量操作:支持批量文档移动和块操作,提高效率
  • 事务管理:内置事务机制确保数据一致性

🛡️ 安全可靠

  • 认证:支持 API 令牌认证以保护数据安全
  • 错误处理:全面的错误处理机制提供详细的错误信息
  • 参数验证:严格的参数验证防止无效操作

🔌 易于集成

  • MCP 协议:基于 Model Context Protocol,易于与 AI 工具集成
  • 标准接口:遵循思源笔记官方 API 规范- 多语言支持:支持中文和英文文档及错误信息

📊 数据管理

  • 完整的 CRUD 操作:支持所有数据类型的创建、读取、更新和删除
  • 层次结构:支持文档和块的层次组织
  • 引用系统:支持块引用和转移,维护数据关系

🎯 开发者友好

  • 详细日志:提供详细的 API 调用日志,便于调试
  • 状态检查:内置连接状态检查,快速诊断问题
  • 丰富的示例:提供完整的使用示例和最佳实践

📊 API 统计

  • 总 API 数量:49
  • 功能模块:12
  • 支持的操作:完整的思源笔记 API 功能
  • 覆盖率:100% 思源笔记官方 API(不包括网络 API)

📚 使用示例

列出所有笔记本

{
  "name": "list_notebooks",
  "arguments": {}
}

创建新文档

{
  "name": "create_doc",
  "arguments": {
    "notebook": "20241009135857-599ipbh",
    "path": "/daily/2025-01-15",
    "markdown": "# Today's Summary\n\nToday I completed the following work:\n- Project development\n- Document writing"
  }
}

查询最近创建的文档

{
  "name": "sql_query",
  "arguments": {
    "sql": "SELECT * FROM blocks WHERE type = 'd' ORDER BY created DESC LIMIT 5"
  }
}

查找带有特定标签的块

{
  "name": "sql_query",
  "arguments": {
    "sql": "SELECT * FROM blocks WHERE content LIKE '%#important%' OR content LIKE '%#urgent%'"
  }
}

插入块

{
  "name": "insert_block",
  "arguments": {
    "data": "This is new block content",
    "dataType": "markdown",
    "parentID": "20250803150424-tu1cl78"
  }
}

📚 开发资源

相关链接

社区支持

技术栈

  • 语言:TypeScript/JavaScript
  • 协议:模型上下文协议 (MCP)
  • 框架:@modelcontextprotocol/sdk
  • 部署:Docker, Node.js
  • 数据库:SQLite(通过思源笔记)

开发工具

  • 编辑器:VS Code, Cursor
  • 构建工具:TypeScript 编译器
  • 包管理器:npm
  • 容器化:Docker, Docker Compose

🔧 高级特性

1. 模板系统

使用 render_templaterender_sprig 创建动态内容:

{
  "name": "render_sprig",
  "arguments": {
    "template": "Hello {{.name}}! Today is {{.date}}."
  }
}

2. 文件管理

使用文件操作 API 管理附件和资源:

{
  "name": "upload_asset",
  "arguments": {
    "assetsDirPath": "/assets",
    "files": ["image1.jpg", "document.pdf"]
  }
}

3. 数据导出

使用导出功能备份和分享内容:

{
  "name": "export_md_content",
  "arguments": {
    "id": "20250115123456-abcdef"
  }
}

🛠️ 本地开发

全局安装

npm install -g siyuan-mcp
siyuan-mcp

环境要求

  • Node.js >= 18.0.0
  • npm 或 yarn
  • Git

克隆项目

git clone https://github.com/xgq18237/siyuan_mcp_server.git
cd siyuan_mcp_server

安装依赖

npm install

构建项目

npm run build

开发模式

npm run dev

启动服务器

npm start

Docker 本地部署

  1. 构建镜像
docker build -t siyuan-mcp-server .
  1. 运行容器
docker run -d \
  -e SIYUAN_HOST=127.0.0.1 \
  -e SIYUAN_PORT=6806 \
  -e SIYUAN_TOKEN=your-token \
  --name siyuan-mcp-server \
  siyuan-mcp-server
  1. 使用 Docker Compose
# Configure environment variables
cp env.example .env
# Edit .env file

# Start service
docker-compose up -d

📄 许可证

MIT 许可证


⬆ 返回顶部


中文版本

这是一个基于 模型上下文协议 (MCP) 的思源笔记服务器,提供了完整的思源笔记 API 功能。

🚀 快速开始

使用 npx(推荐)

# 直接运行
npx -y siyuan-mcp@latest

# 设置环境变量
SIYUAN_HOST=127.0.0.1 SIYUAN_PORT=6806 SIYUAN_TOKEN=your-token npx -y siyuan-mcp@latest

使用 Docker

# 拉取镜像
docker pull zhizhiqq/siyuan-mcp:latest

# 运行容器
docker run -d \
  -e SIYUAN_HOST=127.0.0.1 \
  -e SIYUAN_PORT=6806 \
  -e SIYUAN_TOKEN=your-token \
  --name siyuan-mcp-server \
  zhizhiqq/siyuan-mcp:latest

配置 MCP 客户端

Cursor 配置
  1. 打开 Cursor 设置(Ctrl/Cmd + ,)
  2. 搜索 "MCP" 或 "模型上下文协议"
  3. 点击 "Add Server" 或 "添加服务器"
  4. 配置服务器信息:
{
  "mcpServers": {
    "siyuan-mcp": {
      "command": "npx",
      "args": ["-y", "siyuan-mcp@latest"],
      "env": {
        "SIYUAN_HOST": "127.0.0.1",
        "SIYUAN_PORT": "6806",
        "SIYUAN_TOKEN": "your-api-token-here"
      }
    }
  }
}
Claude Desktop 配置
  1. 打开 Claude Desktop 设置
  2. 进入 "模型上下文协议" 设置
  3. 添加新的 MCP 服务器:
{
  "mcpServers": {
    "siyuan-mcp": {
      "command": "npx",
      "args": ["-y", "siyuan-mcp@latest"],
      "env": {
        "SIYUAN_HOST": "127.0.0.1",
        "SIYUAN_PORT": "6806",
        "SIYUAN_TOKEN": "your-api-token-here"
      }
    }
  }
}
Docker 配置

如果你使用 Docker 运行服务,可以配置客户端连接到 Docker 容器:

Cursor Docker 配置

{
  "mcpServers": {
    "siyuan-mcp": {
      "command": "docker",
      "args": ["run", "--rm", "-e", "SIYUAN_HOST=127.0.0.1", "-e", "SIYUAN_PORT=6806", "-e", "SIYUAN_TOKEN=your-api-token-here", "zhizhiqq/siyuan-mcp:latest"],
      "env": {}
    }
  }
}

Claude Desktop Docker 配置

{
  "mcpServers": {
    "siyuan-mcp": {
      "command": "docker",
      "args": ["run", "--rm", "-e", "SIYUAN_HOST=127.0.0.1", "-e", "SIYUAN_PORT=6806", "-e", "SIYUAN_TOKEN=your-api-token-here", "zhizhiqq/siyuan-mcp:latest"],
      "env": {}
    }
  }
}

注意:使用 Docker 配置时,确保 Docker 已安装并正在运行。

🔧 环境变量配置

变量名 说明 默认值 必需
SIYUAN_HOST 思源笔记服务器地址 127.0.0.1
SIYUAN_TOKEN API 令牌 -

📋 常见问题

Q: 连接失败怎么办?

A: 请按以下步骤检查:

  1. 确保思源笔记正在运行
  2. 检查 API 令牌是否正确
  3. 确认思源笔记中有打开的笔记本
  4. 重启思源笔记和 Cursor

Q: 如何获取正确的 API 令牌?

A:

  1. 打开思源笔记
  2. 进入 设置关于API 令牌
  3. 点击 生成令牌 或复制现有令牌
  4. 确保令牌格式正确(通常是一串字母数字组合)

Q: 为什么使用 -y 参数?

A: -y 参数可以自动确认包安装,无需用户交互确认,这对于 MCP 客户端配置非常重要,因为交互式提示会导致连接失败。

🎯 功能特性

📚 笔记本管理

笔记本是思源笔记的基本组织单位,每个笔记本包含多个文档。

  • list_notebooks - 列出所有笔记本,获取笔记本ID和名称
  • open_notebook - 打开指定笔记本,激活工作空间
  • close_notebook - 关闭指定笔记本,释放资源
  • rename_notebook - 重命名笔记本,更新显示名称
  • create_notebook - 创建新笔记本,支持自定义名称
  • remove_notebook - 删除笔记本,清理相关数据
  • get_notebook_conf - 获取笔记本配置信息
  • set_notebook_conf - 保存笔记本配置,自定义设置

📄 文档管理

文档是笔记本中的具体内容单元,支持层级结构和路径管理。

  • create_doc - 在指定笔记本中新建文档,支持Markdown内容
  • rename_doc - 重命名文档,保持内容不变
  • rename_doc_by_id - 根据文档ID重命名,精确操作
  • remove_doc - 删除文档,清理文件系统
  • remove_doc_by_id - 根据文档ID删除,精确操作
  • move_docs - 移动文档到其他位置或笔记本
  • move_docs_by_id - 根据文档ID移动,精确操作
  • get_hpath_by_path - 根据路径获取人类可读路径
  • get_hpath_by_id - 根据ID获取人类可读路径
  • get_path_by_id - 根据ID获取存储路径
  • get_ids_by_hpath - 根据人类可读路径获取IDs

🧩 块操作

块是思源笔记的最小内容单位,支持灵活的编辑、重组和引用。

  • insert_block - 插入块,支持指定位置和数据类型
  • prepend_block - 插入前置子块,在父块开头添加内容
  • append_block - 插入后置子块,在父块末尾添加内容
  • update_block - 更新块内容,支持Markdown和DOM格式
  • delete_block - 删除块,清理相关引用
  • move_block - 移动块到新位置,支持层级调整
  • get_block_kramdown - 获取块kramdown源码,用于导出
  • get_child_blocks - 获取子块列表,遍历块结构
  • fold_block - 折叠块,隐藏子内容
  • unfold_block - 展开块,显示子内容
  • transfer_block_ref - 转移块引用,维护引用关系

🏷️ 属性操作

块属性用于存储元数据和自定义信息,支持键值对存储。

  • set_block_attrs - 设置块属性,支持自定义键值对
  • get_block_attrs - 获取块属性,读取元数据信息

🔍 搜索和查询

通过SQL查询获取思源笔记中的数据,支持复杂查询条件。

  • sql_query - 执行SQL查询,支持所有SQLite语法
  • flush_transaction - 提交事务,确保数据持久化

📁 文件操作

管理思源笔记工作空间中的文件和目录,支持资源管理。

  • get_file - 获取文件内容,读取文件数据
  • remove_file - 删除文件,清理存储空间
  • rename_file - 重命名文件,更新文件路径
  • read_dir - 列出目录内容,浏览文件结构
  • put_file - 写入文件,创建或更新文件内容

📤 导出功能

将思源笔记内容导出为各种格式,支持备份和分享。- export_md_content - 导出Markdown文本,保持格式

  • export_resources - 导出文件与目录,包含资源文件

📢 通知功能

向用户推送消息和错误提示,提供操作反馈。

  • push_msg - 推送消息,显示成功提示
  • push_err_msg - 推送错误消息,显示错误信息

💻 系统信息

获取思源笔记系统状态和运行信息,监控系统健康。

  • get_version - 获取思源笔记版本信息
  • get_current_time - 获取系统当前时间
  • get_boot_progress - 获取启动进度,监控启动状态
  • check_siyuan_status - 检查思源笔记状态和API可用性
  • get_workspace_info - 获取工作空间和连接信息

🎨 模板功能

使用模板系统创建动态内容,支持变量替换。

  • render_template - 渲染模板文件,支持外部模板
  • render_sprig - 渲染Sprig模板,支持内联模板语法

🔄 转换功能

使用Pandoc进行文档格式转换,支持多种输出格式。

  • pandoc_convert - Pandoc转换,支持多种文档格式

📎 资源文件

管理思源笔记中的资源文件,支持批量上传。

  • upload_asset - 上传资源文件,支持批量操作

🔧 核心特性

🚀 高性能

  • 异步处理: 所有API调用采用异步处理,提高响应速度
  • 批量操作: 支持批量文档移动和块操作,提升效率
  • 事务管理: 内置事务机制,确保数据一致性

🛡️ 安全可靠

  • 身份验证: 支持API令牌认证,保护数据安全
  • 错误处理: 完善的错误处理机制,提供详细错误信息
  • 参数验证: 严格的参数验证,防止无效操作

🔌 易于集成

  • MCP协议: 基于Model Context Protocol,易于与AI工具集成
  • 标准接口: 遵循思源笔记官方API规范
  • 多语言支持: 支持中英文文档和错误信息

📊 数据管理

  • 完整CRUD: 支持创建、读取、更新、删除所有数据类型
  • 层级结构: 支持文档和块的层级组织
  • 引用系统: 支持块引用和转移,维护数据关系

🎯 开发友好

  • 详细日志: 提供详细的API调用日志,便于调试
  • 状态检查: 内置连接状态检查,快速诊断问题
  • 示例丰富: 提供完整的使用示例和最佳实践

📊 接口统计

  • 总接口数: 49个
  • 功能模块: 12个
  • 支持的操作: 完整的思源笔记API功能
  • 覆盖范围: 100%思源笔记官方API(除网络接口外)

📚 使用示例

列出所有笔记本
javascript

{
  "name": "list_notebooks",
  "arguments": {}
}

创建新文档
javascript

{
  "name": "create_doc",
  "arguments": {
    "notebook": "20241009135857-599ipbh",
    "path": "/daily/2025-01-15",
    "markdown": "# 今日总结\n\n今天完成了以下工作:\n- 项目开发\n- 文档编写"
  }
}

查询最近创建的文档
javascript

{
  "name": "sql_query",
  "arguments": {
    "sql": "SELECT * FROM blocks WHERE type = 'd' ORDER BY created DESC LIMIT 5"
  }
}

查找包含特定标签的块
javascript

{
  "name": "sql_query",
  "arguments": {
    "sql": "SELECT * FROM blocks WHERE content LIKE '%#重要%' OR content LIKE '%#urgent%'"
  }
}

插入块
javascript

{
  "name": "insert_block",
  "arguments": {
    "data": "这是一个新的块内容",
    "dataType": "markdown",
    "parentID": "20250803150424-tu1cl78"
  }
}

📚 开发资源

相关链接

社区支持

技术栈

  • 语言: TypeScript/JavaScript
  • 协议: Model Context Protocol (MCP)
  • 框架: @modelcontextprotocol/sdk
  • 部署: Docker, Node.js
  • 数据库: SQLite (通过思源笔记)

开发工具

  • 编辑器: VS Code, Cursor
  • 构建工具: TypeScript Compiler
  • 包管理: npm
  • 容器化: Docker, Docker Compose

🔧 高级功能

1. 模板系统

使用render_templaterender_sprig创建动态内容:
javascript

{
  "name": "render_sprig",
  "arguments": {
    "template": "Hello {{.name}}! Today is {{.date}}."
  }
}

2. 文件管理

使用文件操作API管理附件和资源:
javascript

{
  "name": "upload_asset",
  "arguments": {
    "assetsDirPath": "/assets",
    "files": ["image1.jpg", "document.pdf"]
  }
}

3. 数据导出

使用导出功能备份和分享内容:
javascript

{
  "name": "export_md_content",
  "arguments": {
    "id": "20250115123456-abcdef"
  }
}

🛠️ 本地开发

全局安装

bash

npm install -g siyuan-mcp
siyuan-mcp

环境要求

  • Node.js >= 18.0.0
  • npm 或 yarn
  • Git

克隆项目#### 安装依赖

bash

npm install

构建项目

bash

npm run build

开发模式

bash

npm run dev

启动服务器

bash

npm start

Docker 本地部署

  1. 构建镜像
    bash
    docker build -t siyuan-mcp-server .
    
  2. 运行容器
    bash
    docker run -d \
      -e SIYUAN_HOST=127.0.0.1 \
      -e SIYUAN_PORT=6806 \
      -e SIYUAN_TOKEN=your-token \
      --name siyuan-mcp-server \
      siyuan-mcp-server
    
  3. 使用 Docker Compose
    bash
    # 配置环境变量
    cp env.example .env
    # 编辑 .env 文件
    
    # 启动服务
    docker-compose up -d
    

📄 许可证

MIT License


⬆ 返回顶部

相关 MCP 服务