{"id":21999922,"url":"https://github.com/MarkusPfundstein/mcp-obsidian","last_synced_at":"2025-07-23T03:31:42.946Z","repository":{"id":265457857,"uuid":"896007696","full_name":"MarkusPfundstein/mcp-obsidian","owner":"MarkusPfundstein","description":"MCP server that interacts with Obsidian via the Obsidian rest API community plugin","archived":false,"fork":false,"pushed_at":"2024-11-29T13:31:09.000Z","size":29,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-29T13:32:36.658Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MarkusPfundstein.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-29T11:07:12.000Z","updated_at":"2024-11-29T13:31:13.000Z","dependencies_parsed_at":"2024-11-29T22:02:42.996Z","dependency_job_id":null,"html_url":"https://github.com/MarkusPfundstein/mcp-obsidian","commit_stats":null,"previous_names":["markuspfundstein/mcp-obsidian"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarkusPfundstein%2Fmcp-obsidian","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarkusPfundstein%2Fmcp-obsidian/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarkusPfundstein%2Fmcp-obsidian/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarkusPfundstein%2Fmcp-obsidian/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MarkusPfundstein","download_url":"https://codeload.github.com/MarkusPfundstein/mcp-obsidian/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227230628,"owners_count":17751472,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-29T23:08:59.572Z","updated_at":"2025-07-23T03:31:42.937Z","avatar_url":"https://github.com/MarkusPfundstein.png","language":"Python","funding_links":[],"categories":["Productivity","👥 Community Contributions","Documentation \u0026 Learning Resources","Python","📝 \u003ca name=\"note-taking\"\u003e\u003c/a\u003eNote Taking","📚 Projects (1974 total)","MCP 服务器精选列表","Legend","Community Servers","📦 Other","Note Taking","サーバー実装","Servers","AI Productivity","MCP Servers","Other Tools and Integrations","Table of Contents","Productivity \u0026 Workflow","MCP Ecosystem"],"sub_categories":["Obsidian","Productivity \u0026 Knowledge Management","MCP Servers","🛠️ 效率工具与集成 (Office, Project Management, Notes, etc.)","🛠️ \u003ca name=\"other-tools-and-integrations\"\u003e\u003c/a\u003eOther Tools and Integrations","🛠️ \u003ca name=\"other-tools-and-integrations\"\u003e\u003c/a\u003eその他のツールと統合","Python","🛠️ Other Tools and Integrations","Knowledge Management","Other Tools and Integrations","Knowledge \u0026 Memory","Servers"],"readme":"# MCP server for Obsidian\n\nMCP server to interact with Obsidian via the Local REST API community plugin.\n\n\u003ca href=\"https://glama.ai/mcp/servers/3wko1bhuek\"\u003e\u003cimg width=\"380\" height=\"200\" src=\"https://glama.ai/mcp/servers/3wko1bhuek/badge\" alt=\"server for Obsidian MCP server\" /\u003e\u003c/a\u003e\n\n## Components\n\n### Tools\n\nThe server implements multiple tools to interact with Obsidian:\n\n- list_files_in_vault: Lists all files and directories in the root directory of your Obsidian vault\n- list_files_in_dir: Lists all files and directories in a specific Obsidian directory\n- get_file_contents: Return the content of a single file in your vault.\n- search: Search for documents matching a specified text query across all files in the vault\n- patch_content: Insert content into an existing note relative to a heading, block reference, or frontmatter field.\n- append_content: Append content to a new or existing file in the vault.\n- delete_file: Delete a file or directory from your vault.\n\n### Example prompts\n\nIts good to first instruct Claude to use Obsidian. Then it will always call the tool.\n\nThe use prompts like this:\n- Get the contents of the last architecture call note and summarize them\n- Search for all files where Azure CosmosDb is mentioned and quickly explain to me the context in which it is mentioned\n- Summarize the last meeting notes and put them into a new note 'summary meeting.md'. Add an introduction so that I can send it via email.\n\n## Configuration\n\n### Obsidian REST API Key\n\nThere are two ways to configure the environment with the Obsidian REST API Key. \n\n1. Add to server config (preferred)\n\n```json\n{\n  \"mcp-obsidian\": {\n    \"command\": \"uvx\",\n    \"args\": [\n      \"mcp-obsidian\"\n    ],\n    \"env\": {\n      \"OBSIDIAN_API_KEY\": \"\u003cyour_api_key_here\u003e\",\n      \"OBSIDIAN_HOST\": \"\u003cyour_obsidian_host\u003e\",\n      \"OBSIDIAN_PORT\": \"\u003cyour_obsidian_port\u003e\"\n    }\n  }\n}\n```\nSometimes Claude has issues detecting the location of uv / uvx. You can use `which uvx` to find and paste the full path in above config in such cases.\n\n2. Create a `.env` file in the working directory with the following required variables:\n\n```\nOBSIDIAN_API_KEY=your_api_key_here\nOBSIDIAN_HOST=your_obsidian_host\nOBSIDIAN_PORT=your_obsidian_port\n```\n\nNote:\n- You can find the API key in the Obsidian plugin config\n- Default port is 27124 if not specified\n- Default host is 127.0.0.1 if not specified\n\n## Quickstart\n\n### Install\n\n#### Obsidian REST API\n\nYou need the Obsidian REST API community plugin running: https://github.com/coddingtonbear/obsidian-local-rest-api\n\nInstall and enable it in the settings and copy the api key.\n\n#### Claude Desktop\n\nOn MacOS: `~/Library/Application\\ Support/Claude/claude_desktop_config.json`\n\nOn Windows: `%APPDATA%/Claude/claude_desktop_config.json`\n\n\u003cdetails\u003e\n  \u003csummary\u003eDevelopment/Unpublished Servers Configuration\u003c/summary\u003e\n  \n```json\n{\n  \"mcpServers\": {\n    \"mcp-obsidian\": {\n      \"command\": \"uv\",\n      \"args\": [\n        \"--directory\",\n        \"\u003cdir_to\u003e/mcp-obsidian\",\n        \"run\",\n        \"mcp-obsidian\"\n      ],\n      \"env\": {\n        \"OBSIDIAN_API_KEY\": \"\u003cyour_api_key_here\u003e\",\n        \"OBSIDIAN_HOST\": \"\u003cyour_obsidian_host\u003e\",\n        \"OBSIDIAN_PORT\": \"\u003cyour_obsidian_port\u003e\"\n      }\n    }\n  }\n}\n```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003ePublished Servers Configuration\u003c/summary\u003e\n  \n```json\n{\n  \"mcpServers\": {\n    \"mcp-obsidian\": {\n      \"command\": \"uvx\",\n      \"args\": [\n        \"mcp-obsidian\"\n      ],\n      \"env\": {\n        \"OBSIDIAN_API_KEY\": \"\u003cYOUR_OBSIDIAN_API_KEY\u003e\",\n        \"OBSIDIAN_HOST\": \"\u003cyour_obsidian_host\u003e\",\n        \"OBSIDIAN_PORT\": \"\u003cyour_obsidian_port\u003e\"\n      }\n    }\n  }\n}\n```\n\u003c/details\u003e\n\n## Development\n\n### Building\n\nTo prepare the package for distribution:\n\n1. Sync dependencies and update lockfile:\n```bash\nuv sync\n```\n\n### Debugging\n\nSince MCP servers run over stdio, debugging can be challenging. For the best debugging\nexperience, we strongly recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector).\n\nYou can launch the MCP Inspector via [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) with this command:\n\n```bash\nnpx @modelcontextprotocol/inspector uv --directory /path/to/mcp-obsidian run mcp-obsidian\n```\n\nUpon launching, the Inspector will display a URL that you can access in your browser to begin debugging.\n\nYou can also watch the server logs with this command:\n\n```bash\ntail -n 20 -f ~/Library/Logs/Claude/mcp-server-mcp-obsidian.log\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMarkusPfundstein%2Fmcp-obsidian","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FMarkusPfundstein%2Fmcp-obsidian","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMarkusPfundstein%2Fmcp-obsidian/lists"}