Claude MCP Servers

🚀 Claudio Guide

This guide provides a comprehensive introduction to the installation, configuration, usage, and development of Claudio. It also offers solutions to common issues.

🚀 Quick Start

📦 Installation

Install Dependencies

Use Bun to install the required dependencies:

bun add ts-mdx @types/node zod

Start the Service

Create and run the following script in the project root directory:

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

⚙️ Configure Environment Variables

Edit the .env file and add the following content:

OBSIDIAN_VAULT_DIR=/path/to/obsidian/vault

💻 Usage Examples

Obsidian Functionality

Write a Note

write_note({
  "path": "Projects/新项目",
  "content": "# 新项目\n\n此处记录项目细节。",
  "append": true
})

Delete a Note

delete_note({
  "path": "Projects/旧项目"
})

Read Notes

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

Search Notes

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

📚 MCP Development Guide

Create a New MCP File

Create a new .ts file in the /ts/src/ directory, referring to existing files such as obsidian.ts.

Define Parameter Schema

Use Zod to define input parameters:

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

Implement Tool Functionality

Implement the specific logic in server.setRequestHandler().

Update Configuration Files

Modify claude_desktop_config.template.json and cursor_config.template.json to add a new MCP configuration:

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

Add Environment Variables

Add new environment variables to the .env file as needed and update the README documentation.

❓ Troubleshooting

• Verify Command-line Output: Check for error messages.
• Check the .env File Path: Ensure it is in the correct location.
• Confirm Bun is Running Properly: Test by executing simple commands.
• Verify the Obsidian Vault Path: Ensure OBSIDIAN_VAULT_DIR is set correctly.
• Handle Interactive Installation Issues: Try traditional installation using make setup.

🛠️ Development Philosophy

This project uses Bun as the only package management tool and does not support other tools such as npm or yarn. All installation and running operations must be executed using the bun command.