wehub-resource-sync
db1d565b64
Integration Tests / melodic (push) Has been cancelled
Integration Tests / noetic (push) Has been cancelled
Integration Tests / humble (push) Has been cancelled
Integration Tests / jazzy (push) Has been cancelled
Ruff Lint & Format / ruff (push) Has been cancelled
Sync main to develop / Check if sync is needed (push) Has been cancelled
Sync main to develop / Sync main to develop (push) Has been cancelled
66 lines
2.1 KiB
Markdown
66 lines
2.1 KiB
Markdown
# Step 1: Codex CLI Setup
|
|
|
|
[Codex CLI](https://github.com/openai/codex) is OpenAI's CLI agent for software development. It supports MCP servers natively. If you don't have it yet, see the [installation instructions](https://github.com/openai/codex#getting-started).
|
|
|
|
## 1. Install uv
|
|
|
|
[uv](https://docs.astral.sh/uv/) is needed to run the MCP server via `uvx`.
|
|
|
|
```bash
|
|
curl -LsSf https://astral.sh/uv/install.sh | sh
|
|
```
|
|
|
|
See the [uv installation docs](https://docs.astral.sh/uv/getting-started/installation/) for other platforms or troubleshooting.
|
|
|
|
## 2. Add the MCP Server
|
|
|
|
Edit your Codex CLI configuration file at `~/.codex/config.json` and add the MCP server:
|
|
|
|
```json
|
|
{
|
|
"mcpServers": {
|
|
"ros-mcp-server": {
|
|
"command": "uvx",
|
|
"args": ["ros-mcp", "--transport=stdio"]
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
> **Tip:** If you're having trouble with the config file, ask Codex to help set it up. Tell it that the command to run the MCP server is `uvx ros-mcp` and it can generate the correct configuration.
|
|
|
|
## 3. Verify the Setup
|
|
|
|
Start Codex CLI and ask it to connect to a robot:
|
|
|
|
```bash
|
|
codex
|
|
```
|
|
|
|
```
|
|
Connect to the robot on localhost using the ros-mcp server
|
|
```
|
|
|
|
The MCP server will attempt to reach a robot on the same machine. It should report that the IP is reachable but the rosbridge port is closed — this confirms the MCP server is set up correctly.
|
|
|
|
> **Tip:** If your AI assistant can't find the ros-mcp server, exit and restart Codex CLI so it picks up the new configuration.
|
|
|
|
To complete the connection, [set up rosbridge](../rosbridge.md) on your robot.
|
|
|
|
## Next Step
|
|
|
|
Set up rosbridge on the machine where ROS is running: [Step 2: Rosbridge Setup](../rosbridge.md)
|
|
|
|
---
|
|
|
|
### Advanced
|
|
|
|
- [HTTP transport](../http-transport.md) — run the MCP server as a standalone HTTP service instead of stdio
|
|
- Alternate installation methods:
|
|
- [Install via pip](../pip.md) — traditional `pip install` or install from source with pip
|
|
- [Install from source](../from-source.md) — for developers who need to modify the server code
|
|
|
|
---
|
|
|
|
[Back to Installation Guide](../installation.md) | [Troubleshooting](../troubleshooting.md)
|