mcpkit-actix 0.5.0

Actix-web integration for mcpkit
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

# mcpkit-actix

Actix-web integration for the Model Context Protocol (MCP).

This crate provides integration between the MCP SDK and the Actix-web framework, making it easy to expose MCP servers over HTTP.

## Features

- HTTP POST endpoint for JSON-RPC messages
- Server-Sent Events (SSE) streaming for notifications
- Session management with automatic cleanup
- Protocol version validation
- CORS support

## Usage

```rust
use mcpkit_actix::McpRouter;
use mcpkit_server::ServerHandler;

// Your MCP server handler (must implement ServerHandler, ToolHandler, etc.)
// Note: Clone is NOT required - the handler is wrapped in Arc internally.
struct MyServer;

#[actix_web::main]
async fn main() -> std::io::Result<()> {
    // Simplest approach: use McpRouter for stdio-like ergonomics
    McpRouter::new(MyServer)
        .with_cors()
        .with_logging()
        .serve("0.0.0.0:3000")
        .await
}
```

### Default Endpoints

| Endpoint | Method | Purpose |
|----------|--------|---------|
| `/mcp` | POST | JSON-RPC messages |
| `/mcp/sse` | GET | Server-Sent Events stream |

### Customizing Paths

```rust
McpRouter::new(MyServer)
    .post_path("/api/mcp")
    .sse_path("/api/mcp/sse")
    .serve("0.0.0.0:3000")
    .await
```

### Integration with Existing App

For more control, integrate MCP routes into an existing Actix-web application:

```rust
use mcpkit_actix::McpRouter;
use mcpkit_server::ServerHandler;
use actix_web::{App, HttpServer};

struct MyServer;

#[actix_web::main]
async fn main() -> std::io::Result<()> {
    let router = McpRouter::new(MyServer);

    HttpServer::new(move || {
        App::new()
            .configure(router.configure_app())
            // Add your other routes here
    })
    .bind("0.0.0.0:3000")?
    .run()
    .await
}
```

## Exports

| Export | Purpose |
|--------|---------|
| `McpRouter` | Router builder for MCP endpoints |
| `McpState` | Shared state for MCP handlers |
| `handle_mcp_post` | Handler for POST requests |
| `handle_sse` | Handler for SSE streaming |
| `Session` | Individual client session |
| `SessionManager` | Manages SSE broadcast channels |
| `SessionStore` | Storage for HTTP session data |

## Part of mcpkit

This crate is part of the [mcpkit](https://crates.io/crates/mcpkit) SDK. For most use cases, depend on `mcpkit` directly rather than this crate.

## License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.