obsidian-mcp-server
If you are the rightful owner of obsidian-mcp-server and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to henry@mcphub.com.
OBSIDIAN-MCP-SERVER is a Model Context Protocol (MCP) Stdio server that integrates with LLM Agents to provide Python-based Obsidian functionalities.
OBSIDIAN-MCP-SERVER
LLM Agent์ ์ฐ๋ ๊ฐ๋ฅํ Model Context Protocol (MCP) Stdio ์๋ฒ์ ๋๋ค. ์ด ์๋ฒ๋ LLM Agent๊ฐ Obsidian ๊ด๋ จ ๊ธฐ๋ฅ์ ํ์ฉํ ์ ์๋๋ก Python ๊ธฐ๋ฐ์ Obsidian ๊ด๋ จ ๊ธฐ๋ฅ๋ค์ ์ ๊ณตํฉ๋๋ค.
๊ธฐ๋ฅ
Vault ๊ด๋ฆฌ
- Vault ์์ฑ
- Vault ์ญ์
- Vault ๋ชฉ๋ก ์กฐํ
- Vault ์ ๋ณด ์กฐํ
- Vault ์ค์ ์กฐํ
- Vault ์ค์ ๋ณ๊ฒฝ
ํ์ผ ๊ด๋ฆฌ
- Vault ํ์ผ ๋ชฉ๋ก ์กฐํ
- Vault ํ์ผ ์์ฑ(์์ฑ/์์ )
- Vault ํ์ผ ์ญ์
์ค์น ๋ฐฉ๋ฒ
- ์ ์ฅ์ ํด๋ก
git clone https://github.com/your-username/obsidian-mcp-server.git
cd obsidian-mcp-server
- ๊ฐ์ ํ๊ฒฝ ์์ฑ ๋ฐ ํ์ฑํ
python -m venv venv
source venv/bin/activate # Linux/Mac
# ๋๋
.\venv\Scripts\activate # Windows
- ์์กด์ฑ ์ค์น
pip install -r requirements.txt
- ํ๊ฒฝ ๋ณ์ ์ค์
.env
ํ์ผ์ ์์ฑํ๊ณ ๋ค์ ๋ด์ฉ์ ์ถ๊ฐํฉ๋๋ค:
OBSIDIAN_VAULT_PATH=/path/to/your/obsidian/vault
์ฌ์ฉ ๋ฐฉ๋ฒ
์๋ฒ ์คํ
python main.py
API ์ฌ์ฉ ์์
Vault ์์ฑ
{
"jsonrpc": "2.0",
"method": "create_vault",
"params": {
"vault_name": "my_vault",
"path": "/optional/custom/path"
},
"id": 1
}
Vault ๋ชฉ๋ก ์กฐํ
{
"jsonrpc": "2.0",
"method": "list_vaults",
"params": {},
"id": 2
}
ํ์ผ ์์ฑ
{
"jsonrpc": "2.0",
"method": "write_vault_file",
"params": {
"vault_name": "my_vault",
"file_path": "notes/example.md",
"content": "# Example Note\n\nThis is a test note."
},
"id": 3
}
์๋ฌ ์ฝ๋
- -32000: ์ผ๋ฐ ์ค๋ฅ
- -32001: Vault๋ฅผ ์ฐพ์ ์ ์์
- -32002: Vault๊ฐ ์ด๋ฏธ ์กด์ฌํจ
- -32003: ํ์ผ์ ์ฐพ์ ์ ์์
- -32004: ๊ฒฝ๋ก๋ฅผ ์ฐพ์ ์ ์์
- -32005: ์ค์ ํ์ผ์ ์ฐพ์ ์ ์์
- -32006: ์๋ชป๋ ์ค์
- -32007: ํ์ผ ์์ ์ค๋ฅ
- -32008: ์๋ชป๋ ์์ฒญ
- -32009: ํ๊ฒฝ ๋ณ์ ์ค์ ์ค๋ฅ
- -32010: Obsidian ๋๋ ํ ๋ฆฌ ์ค๋ฅ
์๋ต ํ์
์ฑ๊ณต ์๋ต
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"status": "success",
"message": "Operation completed successfully",
"data": {}
}
}
์ค๋ฅ ์๋ต
{
"jsonrpc": "2.0",
"id": 1,
"error": {
"code": -32001,
"message": "Vault 'my_vault' does not exist"
}
}
๋ผ์ด์ ์ค
MIT License
Cursor ์ค์น ๋ฐฉ๋ฒ
Cursor์์ ์ด MCP ์๋ฒ๋ฅผ ์ฌ์ฉํ๋ ค๋ฉด ๋ค์๊ณผ ๊ฐ์ด ์ค์ ํ์ธ์:
"obsidian-mcp-server": {
"transport": "stdio",
"command": "/path/to/your/venv/bin/python",
"args": ["/path/to/your/obsidian-mcp-server/main.py"],
"env": {
"OBSIDIAN_VAULT_PATH": "/path/to/your/obsidian/vault"
}
}
๊ฐ ๊ฒฝ๋ก๋ฅผ ์์ ์ ํ๊ฒฝ์ ๋ง๊ฒ ์์ ํ์ธ์:
/path/to/your/venv/bin/python
: Python ๊ฐ์ํ๊ฒฝ์ Python ์คํ ํ์ผ ๊ฒฝ๋ก/path/to/your/obsidian-mcp-server/main.py
: ์ด ํ๋ก์ ํธ์ main.py ํ์ผ ๊ฒฝ๋ก/path/to/your/obsidian/vault
: Obsidian Vault ๊ฒฝ๋ก