diff --git a/.gitignore b/.gitignore index ffe6af4..c88efcc 100644 --- a/.gitignore +++ b/.gitignore @@ -7,5 +7,6 @@ hpc-ai-mcp/ .claude/settings.local.json server/dataset-* remotemanager.log +uv.lock # Third-party IRI spec (ALCF, no redistribution license) — fetch when needed (see AGENTS.md) openapi.json diff --git a/README.md b/README.md index e7fe67c..85aa75a 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,69 @@ codex plugin marketplace add RIKEN-RCCS/Rikyu-Agent Then open `/plugins`, install `rikyu`, start a new thread, and run `/ai4s-demo` to verify the connection end-to-end. +### Manual (any MCP-compatible client) + +Clone the repository wherever you prefer: + +```bash +git clone https://github.com/RIKEN-RCCS/Rikyu-Agent.git +``` + +#### Option A — Using Hatch! + +[Hatch!](https://github.com/CrackingShells/Hatch) registers MCP servers on +any supported host from a single command. Install it once, then configure +both servers — replace `/path/to/Rikyu-Agent` with the actual clone location +and `` with your target platform (`claude-code`, `codex`, `cursor`, +`vscode`, `claude-desktop`, `kiro`, `gemini`, `lmstudio`, or any other +[supported host](https://github.com/CrackingShells/Hatch#supported-mcp-hosts)): + +```bash +pip install hatch-xclam + +hatch mcp configure rikyu-hpc --host \ + --command uv --args "run --directory /path/to/Rikyu-Agent/server rikyu-hpc-mcp" + +hatch mcp configure rikyu-docs --host \ + --command uv --args "run --directory /path/to/Rikyu-Agent/server rikyu-docs-mcp" +``` + +To replicate the same configuration to additional hosts: + +```bash +hatch mcp sync --from-host --to-host cursor,vscode +``` + +#### Option B — Edit `.mcp.json` directly + +Create or edit `.mcp.json` in your project root, replacing `/path/to/Rikyu-Agent` +with the actual clone location: + +```json +{ + "mcpServers": { + "rikyu-hpc": { + "command": "uv", + "args": ["run", "--directory", "/path/to/Rikyu-Agent/server", "rikyu-hpc-mcp"], + "env": {} + }, + "rikyu-docs": { + "command": "uv", + "args": ["run", "--directory", "/path/to/Rikyu-Agent/server", "rikyu-docs-mcp"], + "env": {} + } + } +} +``` + +#### Verify + +Whichever option you chose, run the doctor check to verify connectivity: + +```bash +uv run --directory /path/to/Rikyu-Agent/server rikyu-doctor +``` + ## Configuration Settings live in `~/.rikyu/config.json`: