diff --git a/README.md b/README.md index 469982c..5a49eec 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# mcp-knowledge-base MCP server +# MCP server for Obsidian -Example MCP server to interact with Obsidian. +MCP server to interact with Obsidian via the Local REST API community plugin. ## Components @@ -58,13 +58,13 @@ On Windows: `%APPDATA%/Claude/claude_desktop_config.json` ```json { "mcpServers": { - "mcp-knowledge-base": { + "mcp-obsidian": { "command": "uv", "args": [ "--directory", - "/mcp-knowledge-base", + "/mcp-obsidian", "run", - "mcp-knowledge-base" + "mcp-obsidian" ] } } @@ -78,10 +78,10 @@ On Windows: `%APPDATA%/Claude/claude_desktop_config.json` ```json { "mcpServers": { - "mcp-knowledge-base": { + "mcp-obsidian": { "command": "uvx", "args": [ - "mcp-knowledge-base" + "mcp-obsidian" ] } } @@ -91,7 +91,7 @@ On Windows: `%APPDATA%/Claude/claude_desktop_config.json` ## Development -### Building and Publishing +### Building To prepare the package for distribution: @@ -100,22 +100,6 @@ To prepare the package for distribution: uv sync ``` -2. Build package distributions: -```bash -uv build -``` - -This will create source and wheel distributions in the `dist/` directory. - -3. Publish to PyPI: -```bash -uv publish -``` - -Note: You'll need to set PyPI credentials via environment variables or command flags: -- Token: `--token` or `UV_PUBLISH_TOKEN` -- Or username/password: `--username`/`UV_PUBLISH_USERNAME` and `--password`/`UV_PUBLISH_PASSWORD` - ### Debugging Since MCP servers run over stdio, debugging can be challenging. For the best debugging @@ -124,7 +108,7 @@ experience, we strongly recommend using the [MCP Inspector](https://github.com/m You can launch the MCP Inspector via [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) with this command: ```bash -npx @modelcontextprotocol/inspector uv --directory /path/to/mcp-knowledge-base run mcp-knowledge-base +npx @modelcontextprotocol/inspector uv --directory /path/to/mcp-obsidian run mcp-obsidian ``` Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging. @@ -132,5 +116,5 @@ Upon launching, the Inspector will display a URL that you can access in your bro You can also watch the server logs with this command: ```bash -tail -n 20 -f ~/Library/Logs/Claude/mcp-server-mcp-knowledge-base.log +tail -n 20 -f ~/Library/Logs/Claude/mcp-server-mcp-obsidian.log ``` diff --git a/pyproject.toml b/pyproject.toml index 2a0bd7a..fa1169a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,7 @@ [project] -name = "mcp-knowledge-base" +name = "mcp-obsidian" version = "0.1.0" -description = "Example MCP server to create a knowledge-base" +description = "MCP server to work with Obsidian via the remote REST plugin" readme = "README.md" requires-python = ">=3.13" dependencies = [ @@ -23,4 +23,4 @@ dev = [ ] [project.scripts] -mcp-knowledge-base = "mcp_knowledge_base:main" +mcp-obsidian = "mcp_obsidian:main" diff --git a/src/mcp_knowledge_base/__init__.py b/src/mcp_obsidian/__init__.py similarity index 100% rename from src/mcp_knowledge_base/__init__.py rename to src/mcp_obsidian/__init__.py diff --git a/src/mcp_knowledge_base/obsidian.py b/src/mcp_obsidian/obsidian.py similarity index 100% rename from src/mcp_knowledge_base/obsidian.py rename to src/mcp_obsidian/obsidian.py diff --git a/src/mcp_knowledge_base/server.py b/src/mcp_obsidian/server.py similarity index 97% rename from src/mcp_knowledge_base/server.py rename to src/mcp_obsidian/server.py index e04fdd3..27995ab 100644 --- a/src/mcp_knowledge_base/server.py +++ b/src/mcp_obsidian/server.py @@ -22,7 +22,7 @@ from . import tools # Configure logging logging.basicConfig(level=logging.INFO) -logger = logging.getLogger("mcp-knowledge-base") +logger = logging.getLogger("mcp-obsidian") api_key = os.getenv("OBSIDIAN_API_KEY") if not api_key: diff --git a/src/mcp_knowledge_base/tools.py b/src/mcp_obsidian/tools.py similarity index 100% rename from src/mcp_knowledge_base/tools.py rename to src/mcp_obsidian/tools.py diff --git a/uv.lock b/uv.lock index 73149ef..fbebabb 100644 --- a/uv.lock +++ b/uv.lock @@ -151,7 +151,7 @@ wheels = [ ] [[package]] -name = "mcp-knowledge-base" +name = "mcp-obsidian" version = "0.1.0" source = { editable = "." } dependencies = [