Claude MCP Servers

🚀 克勞迪歐指南

本指南將詳細介紹克勞迪歐項目的安裝、配置、使用以及開發相關內容，幫助你快速上手並解決常見問題。

🚀 快速開始

📦 安裝指南

安裝依賴

使用Bun進行依賴安裝：

bun add ts-mdx @types/node zod

啟動服務

在項目根目錄下創建並運行以下腳本：

#!/bin/bash
BUN_PATH=./node_modules/.bun/bun
$BUN_PATH run ./src/server.ts

🔧 配置環境變量

編輯.env文件，添加如下內容：

OBSIDIAN_VAULT_DIR=/path/to/obsidian/vault

💻 使用示例

Obsidian功能

基礎用法

以下是Obsidian功能的基礎使用示例：

寫入筆記

write_note({
  "path": "Projects/新項目",
  "content": "# 新項目\n\n此處記錄項目細節。",
  "append": true
})

刪除筆記

delete_note({
  "path": "Projects/舊項目"
})

讀取筆記

read_notes({
  "paths": ["Projects/新項目", "Daily/2025-04-12"]
})

搜索筆記

search_notes({
  "query": "項目"
})

📚 詳細文檔

MCP開發指南

創建新MCP文件

在/ts/src/目錄下創建新的.ts文件，可參考現有文件如obsidian.ts。

定義參數模式

使用Zod定義輸入參數：

const MyToolArgsSchema = z.object({
  param1: z.string().describe("參數1描述"),
  param2: z.number().optional().describe("可選參數2")
});

實現工具功能

在server.setRequestHandler()中實現具體邏輯。

更新配置文件

修改claude_desktop_config.template.json和cursor_config.template.json，添加新MCP配置：

"my-new-tool": {
  "command": "{{BUN_PATH}}",
  "args": ["運行", "{{PROJECT_ROOT}}/ts/src/my-new-tool.ts", "{{SOME_PARAMETER}}"]
}

添加環境變量

根據需要在.env文件中添加新的環境變量，並更新README文檔說明。

❓ 常見問題解決

• ⚠️ 驗證命令行輸出：確認是否有錯誤信息。
• ⚠️ 檢查.env文件路徑：確保其位置正確。
• ⚠️ 確認Bun運行正常：通過執行簡單命令測試。
• ⚠️ Obsidian功能確認vault路徑：保證OBSIDIAN_VAULT_DIR設置無誤。
• ⚠️ 交互式安裝問題處理：嘗試使用make setup進行傳統安裝。

🌟 開發理念

本項目僅使用Bun作為包管理工具，不支持npm、yarn等其他工具。所有安裝和運行操作均需通過bun命令執行。