Obsidian-MCP 项目安装与使用教程

Obsidian-MCP 项目安装与使用教程

obsidian-mcp A simple MCP server for Obsidian 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-mcp

1. 项目目录结构及介绍

Obsidian-MCP 项目的主要目录结构如下：

obsidian-mcp/
├── .gitignore
├── .vscode
│   └── settings.json
├── HELP.md
├── License.txt
├── README.md
├── bin
│   └── mcp
├── build.gradle
├── gradle
│   └── wrapper
│       └── gradle-wrapper.jar
├── lib
│   └── asm-all-5.2.zip
├── run
│   └── mcp
├── src
│   ├── main
│   │   ├── java
│   │   ├── resources
│   │   └── webapp
│   └── test
│       ├── java
│       └── resources
└── webpack.config.js

• .gitignore: 指定 Git 忽略的文件和目录。
• .vscode/settings.json: Visual Studio Code 的配置文件。
• HELP.md: 项目帮助文档。
• License.txt: 项目许可证信息。
• README.md: 项目简介和使用说明。
• bin: 存放可执行文件的目录。
• build.gradle: Gradle 构建脚本。
• gradle: 存放 Gradle 相关文件的目录。
• lib: 存放项目依赖库的目录。
• run: 存放运行脚本的目录。
• src: 源代码目录，包含 main 和 test 子目录。
  • main: 主代码目录。
    • java: Java 源代码。
    • resources: 资源文件。
    • webapp: Web 应用目录。
  • test: 测试代码目录。
    • webpack.config.js: Webpack 配置文件。

2. 项目的启动文件介绍

项目的启动文件位于 run/mcp 目录中，具体为 mcp 脚本。此脚本用于启动项目。运行该脚本的命令如下：

cd run
./mcp

根据您的操作系统，可能需要为 mcp 脚本文件添加执行权限：

chmod +x run/mcp

3. 项目的配置文件介绍

项目的配置文件位于 src/main/resources 目录中，以下是一些主要的配置文件：

• application.properties: 应用程序配置文件，可以在此文件中配置数据库连接、端口号等信息。
• log4j.properties: Log4j 日志配置文件，用于配置日志输出格式和级别。

您可以根据需要修改这些配置文件以满足项目需求。例如，修改 application.properties 中的数据库连接信息：

spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=root
spring.datasource.password=123456

完成配置后，即可按照启动文件介绍中的方法启动项目。

obsidian-mcp A simple MCP server for Obsidian 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-mcp