笔记增强服务器

一个基于TypeScript的MCP服务器,通过自定义提示和模板增强Obsidian的笔记创建功能。

  • by divy-03
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 divy-03/obsidian-enhanced-mcp

使用说明

增强型黑曜石MCP服务器

一个使用TypeScript实现的MCP(模型上下文协议)服务器,它通过自定义提示和基于模板的笔记创建功能来增强Obsidian。

特点/功能

✨(这个符号本身没有固定的中文翻译,通常可以表示“闪耀”、“光芒”或用于表达某种积极、美好的情绪,如“✨闪耀的未来”或“✨美好的一天”) 自定义提示 - 为常见工作流预配置的模板 📝 模板集成 - 使用您Obsidian知识库中的模板 ⚡(闪电符号,常用于表示速度、能量或惊喜等概念,在中文中无直接对应文字,可保留原样或根据上下文意译) 快速创建 - 用一条命令创建结构化笔记 🐳 这个表情符号通常代表“海豚”,在中文里可以直接翻译为“海豚”。不过,具体含义可能根据上下文有所不同,有时也可能被用作一种可爱或俏皮的表达。 Docker 准备就绪 - 已容器化,便于部署

快速入门

# Install dependencies
npm install

# Build TypeScript
npm run build

# Build Docker image
docker build -t obsidian-enhanced-mcp:latest .

# Test locally
npm start

可用提示

学习笔记

创建结构化的学习笔记,包含概念、示例和资源等部分。

Create a learning note about [topic] from [source]

博客文章

创建带有前置信息和适当结构的博客文章。

Create a blog post titled "[title]" with tags [tags] and category [category]

项目文档

创建全面的项目文档。

Create project documentation for "[project]" as a [type] project

配置

添加到您的 mcp-config.json:

{
  "mcpServers": {
    "obsidian-enhanced": {
      "command": "docker",
      "args": ["run", "--rm", "-i", "obsidian-enhanced-mcp:latest"]
    }
  }
}

项目结构

obsidian-enhanced-mcp/
├── src/
│   └── index.ts          # Main server
├── dist/                  # Compiled code
├── package.json
├── tsconfig.json
├── Dockerfile
└── README.md

模板

模板存储在您的Obsidian知识库中:

  • Templates/note-template.md - 学习笔记
  • Templates/blog-template.md - 博客文章
  • Templates/doc-template.md - 项目文档

发展

# Watch mode
npm run dev

# Build only
npm run build

# Start server
npm start

要求

  • Node.js >= 20.0.0
  • npm 版本 >= 9.0.0
  • Docker(可选)

许可证

麻省理工学院(MIT)

链接