Skip to content

docs(readme): refresh registry README sources for npm, PyPI, and the VS Code marketplaces #1736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
charliegillet wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft

docs(readme): refresh registry README sources for npm, PyPI, and the VS Code marketplaces #1736

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ecd17ae
docs(readme): refresh registry README sources for npm, PyPI, and the …
charliegillet Jul 29, 2026
748c648
docs(readme): OSS-first framing, corrected counts, and API accuracy f…
charliegillet Jul 31, 2026
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
6 changes: 3 additions & 3 deletions apps/vscode/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
"publisher": "rocketride",
"repository": {
"type": "git",
"url": "https://github.com/rocketride-ai/rocketride-server.git"
"url": "https://github.com/rocketride-org/rocketride-server.git"
},
"homepage": "https://github.com/rocketride-ai/rocketride-server#readme",
"homepage": "https://github.com/rocketride-org/rocketride-server#readme",
"bugs": {
"url": "https://github.com/rocketride-ai/rocketride-server/issues"
"url": "https://github.com/rocketride-org/rocketride-server/issues"
},
"license": "MIT",
"keywords": [
Expand Down
35 changes: 24 additions & 11 deletions docs/README-mcp-client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src="https://raw.githubusercontent.com/rocketride-org/rocketride-server/main/images/banner-mcp.png" alt="RocketRide MCP Server" width="900">
<img src="https://raw.githubusercontent.com/rocketride-org/rocketride-server/develop/images/banner-mcp.png" alt="RocketRide MCP Server" width="900">
</p>

<p align="center">
Expand All @@ -23,11 +23,17 @@
pip install rocketride-mcp
```

Or run it without installing:

```bash
uvx rocketride-mcp
```

Configure your MCP client to use the server (see examples below), then ask your AI assistant to process files through your running RocketRide pipelines.

## How It Works

The MCP server connects to a running RocketRide engine and dynamically exposes your pipelines as MCP tools. When an AI assistant calls a tool, the server sends the file to the corresponding pipeline and returns the result.
The MCP server connects to a running RocketRide engine over DAP (Debug Adapter Protocol) on a WebSocket and dynamically exposes your pipelines as MCP tools. When an AI assistant calls a tool, the server sends the file to the corresponding pipeline and returns the result.

```
AI Assistant (Claude, Cursor, ...)
Expand All @@ -47,14 +53,14 @@ Running pipelines are discovered automatically - start a pipeline in VS Code or

## What is RocketRide?

[RocketRide](https://rocketride.org) is an open-source, developer-native AI pipeline platform.
It lets you build, debug, and deploy production AI workflows without leaving your IDE --
[RocketRide](https://rocketride.org) is an open source, developer-native AI pipeline platform.
It lets you build, debug, and deploy production AI workflows without leaving your IDE,
using a visual drag-and-drop canvas or code-first with TypeScript and Python SDKs.

- **50+ ready-to-use nodes** - 13 LLM providers, 8 vector databases, OCR, NER, PII anonymization, and more
- **High-performance C++ engine** - production-grade speed and reliability
- **Deploy anywhere** - locally, on-premises, or self-hosted with Docker
- **MIT licensed** - fully open-source, OSI-compliant
- **115+ pipeline nodes**: 16 LLM providers, 9 vector databases, OCR, NER, PII anonymization, and more
- **High-performance C++ engine**: native multithreading built for AI and data workloads
- **Two ways to run**: self-hosted (free, MIT licensed) with Docker, on-prem, or locally; or [RocketRide Cloud](https://cloud.rocketride.ai/) managed hosting
- **MIT licensed**: fully open source, OSI-compliant

## Installation

Expand All @@ -66,6 +72,12 @@ Requires Python 3.10+ and `rocketride` >= 1.0.4.

## Client Configuration

The examples below point at a local engine (`ws://localhost:5565`). To use [RocketRide Cloud](https://cloud.rocketride.ai/) instead, set `ROCKETRIDE_URI` to `https://api.rocketride.ai` and use your Cloud API token as `ROCKETRIDE_AUTH`.

If you prefer not to install the package, replace `"command": "rocketride-mcp"` with `"command": "uvx"` and `"args": ["rocketride-mcp"]` in the snippets below.

Treat `ROCKETRIDE_AUTH` as a secret. The `"your-api-key"` values below are placeholders: prefer referencing an environment variable over hardcoding a real key, especially in files that get committed (`.cursor/mcp.json` often does). Never commit real keys.

### Claude Desktop

Add to your Claude Desktop config file:
Expand Down Expand Up @@ -108,10 +120,10 @@ Add to `.cursor/mcp.json` in your workspace:
### Claude Code

```bash
claude mcp add rocketride -- rocketride-mcp
claude mcp add rocketride -e ROCKETRIDE_URI=ws://localhost:5565 -e ROCKETRIDE_AUTH=your-api-key -- rocketride-mcp
```

Set `ROCKETRIDE_URI` and `ROCKETRIDE_AUTH` in your environment before running.
Or omit the `-e` flags and set `ROCKETRIDE_URI` and `ROCKETRIDE_AUTH` in your environment before running.

### Command line

Expand Down Expand Up @@ -259,7 +271,7 @@ Set these environment variables (required; no config file is used):

| Variable | Required | Description |
| ------------------- | -------- | ------------------------------------------------------------------- |
| `ROCKETRIDE_URI` | Yes | WebSocket URI of the RocketRide engine (e.g. `ws://localhost:5565`) |
| `ROCKETRIDE_URI` | Yes | Engine URI: `ws://localhost:5565` for a local engine, `https://api.rocketride.ai` for RocketRide Cloud |
| `ROCKETRIDE_AUTH` | Yes\* | API authentication token |
| `ROCKETRIDE_APIKEY` | Yes\* | Alternative to `ROCKETRIDE_AUTH` |
| `MCP_API_KEY` | No | Bearer token for SSE server authentication |
Expand All @@ -272,6 +284,7 @@ Set these environment variables (required; no config file is used):
- [GitHub](https://github.com/rocketride-org/rocketride-server)
- [Discord](https://discord.gg/PMXrtenMsY)
- [Contributing](https://github.com/rocketride-org/rocketride-server/blob/develop/CONTRIBUTING.md)
- [RocketRide Cloud](https://cloud.rocketride.ai/)

## License

Expand Down
Loading
Loading