MCP 工具插件

目录

• 简介
• 安装
• 使用说明
• 安全
• 开发
• 贡献指南
• 支持
• 变更日志
• 许可证
• 脚注

简介

MCP 工具插件（Model Context Protocol Tools，简称 MCP Tools）是一套专为 Obsidian 设计的插件集合，旨在与遵循模型上下文协议（MCP）的 AI 服务进行交互。该插件支持多种功能，包括但不限于数据输入、处理和输出，并兼容多种 MCP 客户端。

安装

前置条件

• Obsidian 最新版本
• 具备互联网连接

下载与安装

1. 访问 MCP Tools 仓库。
2. 在 Releases 页面下载适用于你系统的插件包。
3. 将下载的 .zip 文件解压并复制到 appdata 目录下的 Plugins 文件夹中：

   Windows: C:\Users\<你的用户名>\AppData\Roaming\Obsidian\Plugins
   macOS: /Users/<你的用户名>/Library/Application Support/Obsidian/Plugins
   Linux: ~/.config/obsidian/Plugins
   

使用说明

功能概述

MCP 工具插件主要功能包括：

• 与遵循 MCP 协议的 AI 服务交互
• 提供数据输入、处理和输出功能
• 支持多种格式的数据交换

快速上手

1. 安装完成后重启 Obsidian。
2. 打开侧边栏，选择 MCP 工具插件图标。
3. 在弹出的界面中配置 API 键或访问令牌。
4. 开始使用 MCP 服务。

安全

二进制分发

• 所有发布版本均通过 GitHub Actions 进行可重复构建
• 二进制文件带有 SLSA 出证，确保完整性和来源
• 发布工作流完全符合开源标准

运行时安全

• 服务器以最小权限运行
• 所有通信均为加密
• API 密钥使用平台特定的凭据存储进行保护

开发

工程结构

MCP 工具插件采用单体仓库架构，包含以下模块：

packages/
├── mcp-server/        # 服务器实现
├── obsidian-plugin/   # Obsidian 插件
└── shared/           # 公共工具和类型

使用 Cline

部分代码由 AI 编码代理 Cline 实现，参考 cline_docs/ 和 .clinerules 文件了解项目架构。

工作区

该项目使用 Bun 工作区结构：

依赖管理

1. 安装依赖：

   bun install
   

2. 构建所有包：

   bun run build
   

3. 开发模式运行：

   bun run dev
   

配置要求

• Bun v1.1.42 或更高版本
• TypeScript 5.0+

贡献指南

1. Fork 仓库
2. 创建功能分支
3. 提交更改
4. 运行测试：

   bun test
   

5. 提交 Pull Request

详细指南请参阅 CONTRIBUTING.md。

支持

• 在 Issues 中报告问题和功能需求
• 在 Discussions 中寻求帮助

变更日志

详细变更记录请参考 CHANGELOG.md。

许可证

项目遵循 MIT 许可证，具体条款见 LICENSE 文件。

脚注

1. MCP 协议定义了 AI 服务与客户端之间的交互标准。
2. 插件支持的 API 格式包括 JSON、XML 和自定义格式。
3. 所有脚本均经过严格测试，确保兼容性和稳定性。