From ca119d85f3765ffa347564b859370e372ce2b076 Mon Sep 17 00:00:00 2001 From: VooDisss Date: Fri, 27 Feb 2026 12:42:35 +0200 Subject: [PATCH] docs: simplify MCP install - path argument is optional The server now defaults to current working directory when no path is provided. MCP clients launch the server from the workspace directory, so no explicit path configuration is needed. --- README.md | 40 +++++++++++++++++++++++++--------------- 1 file changed, 25 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index e7f2958..725161d 100644 --- a/README.md +++ b/README.md @@ -32,19 +32,26 @@ Search by what code *does*, not what it's named. ## Install -Add to your MCP config (Claude Code `~/.claude.json`, Cursor settings, etc.): +The MCP server automatically detects the project root — no path argument needed. + +Add to your MCP config (Claude Code `~/.claude.json`, Cursor settings, opencode, etc.): ```json { "mcpServers": { "rpg": { "command": "npx", - "args": ["-y", "-p", "rpg-encoder", "rpg-mcp-server", "/path/to/your/project"] + "args": ["-y", "-p", "rpg-encoder", "rpg-mcp-server"] } } } ``` +> [!TIP] +> The path argument is optional. When omitted, the server falls back to the current working directory. +> MCP clients (like opencode, Claude Code, Cursor) launch the server from the workspace directory, +> so `current_dir()` automatically points to your project. If you pass a path explicitly, it will use that instead. +
Alternative: build from source @@ -59,46 +66,49 @@ Then use the binary path directly: { "mcpServers": { "rpg": { - "command": "/path/to/rpg-encoder/target/release/rpg-mcp-server", - "args": ["/path/to/your/project"] + "command": "/path/to/rpg-encoder/target/release/rpg-mcp-server" } } } ``` +> [!TIP] +> The binary also accepts an optional path argument. Omit it to use the current working directory. +
Multi-repo setup -The MCP server operates on the directory passed as its first argument. For multi-repo usage: +The path argument is optional — the server defaults to the current working directory. This works +automatically because MCP clients launch the server from the workspace directory. -**Option 1: Global config (single primary repo)** +**Global config (all repos use cwd)** -Set your main development repo in `~/.claude.json`: +No path needed — each session uses the directory where the MCP client was started: ```json { "mcpServers": { "rpg": { "command": "npx", - "args": ["-y", "-p", "rpg-encoder", "rpg-mcp-server", "/path/to/primary/repo"] + "args": ["-y", "-p", "rpg-encoder", "rpg-mcp-server"] } } } ``` -**Option 2: Per-project override** +**Per-project override (explicit path)** -Create `.claude/mcp_servers.json` in each repo that needs RPG: +If you need a specific repo, pass the path: ```json { - "rpg": { - "type": "stdio", - "command": "npx", - "args": ["-y", "-p", "rpg-encoder", "rpg-mcp-server", "/path/to/this/repo"], - "env": {} + "mcpServers": { + "rpg": { + "command": "npx", + "args": ["-y", "-p", "rpg-encoder", "rpg-mcp-server", "/path/to/this/repo"] + } } } ```