docs: add user guide for the Oumi MCP server#2374
Merged
aniruddh-alt merged 4 commits intomainfrom Apr 17, 2026
Merged
Conversation
Introduces docs/user_guides/mcp.md covering: - When to use the MCP server vs. the CLI - Installation and client setup (Claude Desktop, Claude Code, Cursor) - Accurate tool and resource catalogs that match src/oumi/mcp/server.py - Path handling, safety gates, and a representative cloud-training flow - Troubleshooting grounded in the server's actual behavior (stdio + stderr logs) Wires the new page into the User Guides toctree.
- Replace the nonexistent `oumi[cloud]` / `oumi[gpu]` install hint with the real per-provider extras (`oumi[aws|azure|gcp|kubernetes|lambda| nebius|runpod]`) that SkyPilot actually needs, mirroring the launch guide. - Stop claiming path-sensitive tools accept `oumi://` URIs. `resolve_ config_path` in `src/oumi/mcp/config_service.py` only handles local filesystem paths; rewrite Path Handling to separate the read-only bundled-config tools (`search_configs`, `get_config`, `list_ categories`) from the path-sensitive ones (`run_oumi_job`, `validate_ config`, `pre_flight_check`). - Rewrite "job_id not found" recovery. The registry in `src/oumi/mcp/job_registry.py` is persistent (`~/.oumi/mcp/oumi-jobs .json`), and `_fetch_cloud_status_direct` matches on `status.id`, not `status.name`. Point users at `list_jobs` to recover the cloud provider's job ID, and at `~/.oumi/mcp/job-logs/<job_id>/` for local logs. - Drop the fabricated `oumi-mcp --help` instruction — `main()` takes no arguments.
The previous tip told users to export credentials in ~/.zshrc or ~/.bashrc. That only works for terminal-launched clients (Claude Code); macOS GUI apps like Claude Desktop and Cursor are started by launchd and never source shell rc files, so the advice would silently fail. Switch to recommending the MCP config's own `env` block, which every stdio-launching client supports, and add a short warning about not committing secrets into the client config.
Drop the registry-vs-runtime architectural digression; users in this failure path just need to know to call list_jobs and where local logs live.
oelachqar
approved these changes
Apr 17, 2026
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
| From the project directory: | ||
|
|
||
| ```bash | ||
| claude mcp add oumi oumi-mcp |
There was a problem hiding this comment.
Bug: The claude mcp add command in the documentation is likely missing the required -- separator before the server command oumi-mcp.
Severity: MEDIUM
Suggested Fix
Update the documentation to include the -- separator in the claude mcp add command. The corrected command should be claude mcp add oumi -- oumi-mcp to ensure it works reliably.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: docs/user_guides/mcp.md#L68
Potential issue: The documentation for the Claude Code CLI setup provides an incorrect
command. The example `claude mcp add oumi oumi-mcp` is missing the required `--`
separator before the server command. Official Claude Code documentation and standard CLI
practices indicate that for stdio-based servers, the syntax should be `claude mcp add
<name> -- <command>`. The double-dash separator is used to distinguish CLI options from
the command to be executed. Omitting it is likely to cause the command to fail for users
following the guide.
Did we get this right? 👍 / 👎 to inform future reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds
docs/user_guides/mcp.md— a dedicated user guide for the Oumi MCP server. Also wires it into the User Guides toctree indocs/index.md.This is a targeted replacement for the MCP section currently proposed in #2372. In that PR the MCP page lists tool names (
launch_job,poll_status,fetch_logs,list_running_jobs,list_completed_jobs) that don't exist insrc/oumi/mcp/server.py, omits 6 tools that do exist, describes a "Prompts" primitive the server doesn't register, and documents anOUMI_LOG_LEVEL=DEBUGenv var that no code reads. A user who tries to follow the page from an MCP-capable assistant hits "unknown tool" errors immediately.This PR rewrites the page from scratch against the actual server:
@mcp.tool()registrations insrc/oumi/mcp/server.py.guidance://*andjobs://*URIs.down_clusterconfirmation gate.sky check, in-process job registry, client log paths).src/oumi/mcp/so contributors can jump to the source.Once this lands, #2372 can drop its MCP section to avoid conflicts.
Related issues
Fixes # (none — doc-only)
Before submitting