Obsidian Model Context Protocol 项目使用教程

Obsidian Model Context Protocol 项目使用教程

mcp-obsidian A connector for Claude Desktop to read and search an Obsidian vault. 项目地址: https://gitcode.com/gh_mirrors/mcp/mcp-obsidian

1. 项目目录结构及介绍

项目的主要目录结构如下：

mcp-obsidian/
├── images/                       # 存放项目相关的图片资源
├── .gitignore                    # 指定git应该忽略的文件和目录
├── .prettierrc                    # Prettier的配置文件
├── LICENSE                       # 项目使用的许可证文件
├── README.md                     # 项目说明文件
├── index.ts                      # 项目的主入口文件
├── package-lock.json             # npm依赖的锁定文件
├── package.json                  # 项目配置文件
└── tsconfig.json                 # TypeScript的配置文件

• images/: 存放与项目相关的图片资源，例如示例或说明图片。
• .gitignore: 用于配置git提交时应该忽略的文件，比如编译生成的文件、配置文件等。
• .prettierrc: Prettier的配置文件，用于统一代码风格。
• LICENSE: 项目的开源许可证，本项目使用AGPL-3.0许可证。
• README.md: 项目的说明文件，包含项目的介绍、安装方式和使用说明。
• index.ts: 项目的主入口文件，包含了实现项目功能的核心代码。
• package-lock.json: npm依赖的锁定文件，用于确保在不同环境中安装的依赖版本一致。
• package.json: 项目配置文件，定义了项目的依赖、脚本和元数据等。
• tsconfig.json: TypeScript的配置文件，定义了TypeScript编译器的选项。

2. 项目的启动文件介绍

项目的启动文件是 index.ts。这是TypeScript编写的入口文件，其中包含了与Claude Desktop进行通信和操作Obsidian vault的代码。具体实现细节如下：

// 伪代码，具体实现需参考实际项目文件
import { someModule } from 'someModule';

function main() {
    // 初始化与Claude Desktop的连接
    const connection = someModule.createConnection();

    // 设置连接的事件监听和处理
    connection.on('data', (data) => {
        // 处理接收到的数据
    });

    // 启动连接
    connection.start();
}

main();

在实际的项目中，开发者需要根据具体需求实现与Claude Desktop的通信逻辑，以及如何处理从Obsidian vault读取的数据。

3. 项目的配置文件介绍

项目的配置文件主要包括 .prettierrc、package.json 和 tsconfig.json。

• .prettierrc: 用于配置Prettier的代码格式化规则，确保代码风格的统一。例如：

{
  "singleQuote": true,
  "trailingComma": "es5",
  "tabWidth": 2,
  "semi": false
}

• package.json: 定义了项目的名称、版本、描述、依赖、脚本等信息。例如：

{
  "name": "mcp-obsidian",
  "version": "1.0.0",
  "description": "A connector for Claude Desktop to read and search an Obsidian vault.",
  "dependencies": {
    // 项目的依赖列表
  },
  "scripts": {
    // 定义项目的脚本命令
  }
}

• tsconfig.json: 用于配置TypeScript编译器的选项，例如：

{
  "compilerOptions": {
    "target": "ES5",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true
  },
  "include": ["src/**/*"]
}

这些配置文件是项目能够顺利运行的基础，开发者需要根据自己的开发环境和项目需求进行适当的配置调整。

mcp-obsidian A connector for Claude Desktop to read and search an Obsidian vault. 项目地址: https://gitcode.com/gh_mirrors/mcp/mcp-obsidian