Obsidian Palace MCP

黑曜石宫MCP

](https://www.npmjs.com/package/obsidian-palace-mcp)  ](https://app.codacy.com/gh/Probably-Computers/obsidian-palace-mcp/dashboard)   ](https://nodejs.org) ](https://github.com/sponsors/Probably-Computers)

一个MCP服务器，将你的黑曜石金库变成一个AI记忆宫殿。

这是什么？

黑曜石宫MCP 使AI助手（Claude、ChatGPT或任何兼容MCP的客户端）能够将您的黑曜石保管库用作持久内存存储。AI可以：

• 储存知识 使用基于意图的存储（AI说什么，Palace决定在哪里）
• 检索信息 使用全文搜索或结构化查询
• 自动链接注释 通过检测对现有笔记标题的提及
• 储存前检查 防止重复并扩展现有知识
• 使用数据视图查询 使用熟悉的DQL语法
• 遵循标准 在vault中定义
• 追踪来源 -知道每一条知识是从哪里来的

v2.0功能

安装

npm install -g obsidian-palace-mcp

或者直接与npx一起使用：

npx obsidian-palace-mcp

快速开始

1.配置克劳德桌面/Claude代码

添加到MCP客户端配置中：

单保险库（快速设置）：

{
  "mcpServers": {
    "obsidian-palace": {
      "command": "npx",
      "args": ["obsidian-palace-mcp"],
      "env": {
        "PALACE_VAULTS": "/path/to/your/obsidian/vault:main:rw"
      }
    }
  }
}

多保险库（快速设置）：

{
  "mcpServers": {
    "obsidian-palace": {
      "command": "npx",
      "args": ["obsidian-palace-mcp"],
      "env": {
        "PALACE_VAULTS": "/path/to/work:work:rw,/path/to/personal:personal:rw",
        "PALACE_DEFAULT_VAULT": "work"
      }
    }
  }
}

多保险库（配置文件）：

{
  "mcpServers": {
    "obsidian-palace": {
      "command": "npx",
      "args": ["obsidian-palace-mcp"],
      "env": {
        "PALACE_CONFIG_PATH": "~/.config/palace/config.yaml"
      }
    }
  }
}

2.创建Vault配置（可选）

创建 .palace.yaml 在vault根目录中进行自定义结构映射：

vault:
  name: my-knowledge
  description: "My knowledge base"

structure:
  technology:
    path: "technologies/{domain}/"
  command:
    path: "commands/{domain}/"
  project:
    path: "projects/{project}/"

看 配置指南 完整的选项。

工具

核心工具

结构与导航

图形智能

查询

标准和人工智能支持

会话

知识组织

知识层

Palace将知识分为三层：

第1层：技术 （从不针对特定项目）

• technologies/ -技术文档
• commands/ -CLI命令和脚本
• reference/ -快速参考

第2层：域 （可重复使用的知识）

• standards/ -标准和惯例
• patterns/ -可重复使用的图案
• research/ -研究结果

第3层：上下文 （项目/客户特定）

• projects/ -项目决策和配置
• clients/ -客户特定知识

基于意图的存储

AI表示要存储什么；宫殿决定地点：

palace_store({
  title: "Docker Bridge Networking",
  content: "...",
  intent: {
    knowledge_type: "command",
    domain: ["docker", "networking"],
    scope: "general"
  }
})
// Resolves to: commands/docker/networking/docker-bridge-networking.md

原子笔记

大型内容会自动拆分为中心+原子注释：

• 每个原子音符最多200行
• 每张钞票最多6个H2部分
• 中心注释(_index.md)提供导航

备注格式

Notes使用YAML frontmatter作为元数据：

---
type: technology
status: active
domain: [kubernetes, networking]
source:
  origin: ai:research
  confidence: 0.8
  verified: false
tags: [kubernetes, networking]
created: 2025-12-05T14:30:00Z
modified: 2025-12-05T14:30:00Z
---

# Kubernetes Networking

Content here...

知识类型

示例用法

存储知识（v2.0方式）

AI: "I'll document this Docker networking command."

[Uses palace_check to verify no existing note]
[Uses palace_store with:
  - knowledge_type: "command"
  - domain: ["docker", "networking"]
  - scope: "general"
  - technologies: ["docker"]
]

查找信息

User: "What do we know about setting up Tailscale?"

AI: [Uses palace_recall with query: "tailscale setup"]
    [Uses palace_related to find connected topics]
    "Based on your notes, here's what we have..."

遵循标准

AI starts session:
[Uses palace_standards({ binding: 'required' })]
[Acknowledges standards before proceeding]

User: "Help me with a git commit"
AI: [Follows git workflow standard from vault]

环境变量

\*除非满足以下条件，否则必须 PALACE_CONFIG_PATH 被设置为指向配置文件。

故障排除

服务器无法启动

“需要PALACE_VAULTS”

• 确保您已设置 PALACE_VAULTS 在MCP客户端配置或使用中 PALACE_CONFIG_PATH
• 格式： path:alias:mode （例如。， /path/to/vault:main:rw)

“找不到模块'better-xlite3'”

• 跑 npm rebuild better-sqlite3 如果全局安装
• 此本机模块可能需要为您的Node版本重新编译

注释未出现

检查保险库路径

• 验证中的路径 PALACE_VAULTS 指向您实际的黑曜石金库
• 路径应包含 .obsidian/ 文件夹

检查忽略模式

• 文件在 .obsidian/, templates/，或包含以下内容的目录 .palace-ignore 被跳过
• 注意事项 palace_ignore: true 在frontmatter中也被跳过

搜索未找到笔记

重建索引

• 删除 .palace/index.sqlite 在vault中，然后重新启动服务器
• 索引将在启动时自动重建

权限错误

只读保险库

• 检查模式 PALACE_VAULTS -使用 :rw 对于读写， :ro 对于只读
• 验证vault目录上的文件系统权限

文档

• API 参考 -完整的工具文档
• 配置指南 -所有配置选项
• AI行为指南 -AI助手协议
• 更新日志 -版本历史

发展

# Clone the repository
git clone https://github.com/Probably-Computers/obsidian-palace-mcp.git
cd obsidian-palace-mcp

# Install dependencies (also sets up Husky pre-commit hooks)
npm install

# Run in development mode
npm run dev

# Run tests
npm test

# Run tests with coverage
npm run test:coverage

# Build for production
npm run build

CI管道

GitHub Actions在每次推送和PR时运行lint、类型检查、构建和测试，覆盖Node 18、20和22 main。保险范围报告给 密码.

预提交钩子

贡献

欢迎投稿！拜托：

1. 分叉存储库
2. 创建要素分支(git checkout -b feature/amazing-feature)
3. 提交您的更改(git commit -m 'feat: add amazing feature')
4. 推到分支(git push origin feature/amazing-feature)
5. 打开拉取请求

看 贡献.md 详细指南。

许可证

该项目根据 GNU Affero通用公共许可证v3.0（AGPL-3.0） -看 许可证 了解详情。

商业用途

如果您需要在专有软件中使用Obsidian Palace MCP，或者将其作为商业SaaS的一部分，而不将您的修改开源，则可以使用商业许可证。看 许可证商业.md 选择。

支持项目

如果您认为黑曜石宫MCP有用，请考虑支持其开发：

• -每月赞助
• 标记回购 -帮助他人发现它
• 报告问题 -帮助提高质量

学分

由...建造 可能是电脑

灵感来自Luci项目的记忆宫概念。