Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
63 changes: 63 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<host>` 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 <host> \
--command uv --args "run --directory /path/to/Rikyu-Agent/server rikyu-hpc-mcp"

hatch mcp configure rikyu-docs --host <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 <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`:
Expand Down