Skip to content

Commit 19217cf

Browse files
committed
docs(readme): polish for HN launch - add Native MCP section, MCP in Quick Start + comparison, fix roadmap header, close dependabot PRs
1 parent 4afa119 commit 19217cf

1 file changed

Lines changed: 27 additions & 1 deletion

File tree

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,22 @@ cargo rustapi replay diff <id> -t local-replay-token --target http://staging
9999

100100
Run HTTP/1.1 (TCP) and HTTP/3 (QUIC/UDP) simultaneously on the same server. Enable with the `core-http3` feature flag.
101101

102+
### Native MCP (Model Context Protocol)
103+
104+
Every RustAPI endpoint is automatically an MCP tool. Zero glue code.
105+
106+
- **In-Process**: ~28 µs per call (vs ~1.3 ms proxy) — **48x faster**
107+
- **CLI**: `cargo rustapi mcp generate --spec any-openapi.json` turns any API into agent tools
108+
- **Stdio**: Native Claude Desktop / Cursor integration
109+
110+
```rust
111+
use rustapi_rs::prelude::*;
112+
use rustapi_rs::protocol::mcp::{McpConfig, McpServer, run_rustapi_and_mcp_with_shutdown};
113+
114+
let mcp = McpServer::from_rustapi(&app, McpConfig::new().allowed_tags(["public"]));
115+
run_rustapi_and_mcp_with_shutdown(app, "0.0.0.0:8080", mcp, "0.0.0.0:9090", tokio::signal::ctrl_c()).await?;
116+
```
117+
102118
### Native OpenAPI 3.1
103119

104120
`#[derive(Schema)]` generates OpenAPI schemas at compile time. `RustApi::auto()` assembles the full spec with reference integrity validation. Swagger UI is served at `/docs` by default. No external code generators or YAML files needed.
@@ -136,6 +152,7 @@ The `extras-jobs` feature (formerly the `rustapi-jobs` crate) provides an async
136152
| Performance | See benchmark source | Workload-dependent | Workload-dependent | Workload-dependent |
137153
| Ergonomics | High | Low | Medium | High |
138154
| AI/LLM native format (TOON) | Yes | No | No | No |
155+
| MCP / AI agent tools (native) | Yes (built-in + CLI + stdio) | No | No | No |
139156
| Request replay / time-travel debug | Built-in | No | No | 3rd-party |
140157
| Circuit breaker / retry | Built-in | 3rd-party | 3rd-party | 3rd-party |
141158
| Adaptive execution paths | 3-tier | No | No | N/A |
@@ -174,6 +191,15 @@ async fn main() -> std::result::Result<(), Box<dyn std::error::Error + Send + Sy
174191

175192
`RustApi::auto()` collects all macro-annotated handlers, generates OpenAPI documentation (served at `/docs`), and starts a multi-threaded tokio runtime.
176193

194+
### MCP in 3 lines
195+
196+
```rust
197+
let mcp = McpServer::from_rustapi(&app, McpConfig::new().allowed_tags(["public"]));
198+
run_rustapi_and_mcp_with_shutdown(app, "0.0.0.0:8080", mcp, "0.0.0.0:9090", tokio::signal::ctrl_c()).await?;
199+
```
200+
201+
Every tagged endpoint becomes an AI agent tool instantly.
202+
177203
> **Tip:** Crate'i `api` (veya `myapi`, `server` vs.) diye alias'lamak en temiz ve FastAPI benzeri deneyimi verir. Makrolar otomatik olarak `#[api::get]`, `#[api::post]`, `#[api::main]` şeklinde çalışır.
178204
179205
For production deployments, you can enable standard probe endpoints without writing handlers manually:
@@ -259,7 +285,7 @@ Meta features: `core` (default), `protocol-all`, `extras-all`, `full`.
259285
- WebSocket permessage-deflate compression
260286
- `rustapi-grpc` crate: optional Tonic/Prost-based gRPC alongside HTTP (`run_rustapi_and_grpc`)
261287

262-
## Roadmap (June 2026)
288+
## Roadmap — v0.1.507 (shipped June 2026)
263289

264290
- [x] Embedded Isometric System Dashboard (`/dashboard`)
265291
- Built-in control plane that boots automatically with a bento-grid layout, dark mode, and glassmorphism styling.

0 commit comments

Comments
 (0)