Skip to content

Commit aa28be0

Browse files
committed
chore: update readme
1 parent c947b70 commit aa28be0

File tree

3 files changed

+30
-12
lines changed

3 files changed

+30
-12
lines changed

Cargo.lock

Lines changed: 4 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ This project currently supports following transports:
3535
- [MCP Client (sse)](#mcp-client-sse)
3636
- [Cargo features](#cargo-features)
3737
- [Available Features](#available-features)
38+
- [MCP protocol versions with corresponding features](#mcp-protocol-versions-with-corresponding-features)
3839
- [Default Features](#default-features)
3940
- [Using Only the server Features](#using-only-the-server-features)
4041
- [Using Only the client Features](#using-only-the-client-features)
@@ -298,9 +299,16 @@ The `rust-mcp-sdk` crate provides several features that can be enabled or disabl
298299
- `ssl`: This feature enables TLS/SSL support for the **sse** transport when used with the `hyper-server`.
299300
- `macros`: Provides procedural macros for simplifying the creation and manipulation of MCP Tool structures.
300301

302+
#### MCP Protocol Versions with Corresponding Features
303+
304+
- `2025_03_26` : Activates MCP Protocol version 2025-03-26 (enabled by default)
305+
- `2024_11_05` : Activates MCP Protocol version 2024-11-05
306+
307+
> Note: MCP protocol versions are mutually exclusive—only one can be active at any given time.
308+
301309
### Default Features
302310

303-
All features are enabled by default. When you include rust-mcp-sdk as a dependency without specifying features, all will be included:
311+
When you add rust-mcp-sdk as a dependency without specifying any features, all features are included, with the latest MCP Protocol version enabled by default:
304312

305313
<!-- x-release-please-start-version -->
306314

@@ -327,13 +335,14 @@ Optionally add `hyper-server` for **sse** transport, and `ssl` feature for tls/s
327335

328336
### Using Only the client Features
329337

330-
If you only need the MCP Client functionality, you can disable the default features and explicitly enable the client feature. Add the following to your Cargo.toml:
338+
If you only need the MCP Client functionality, you can disable the default features and explicitly enable the client feature.
339+
Add the following to your Cargo.toml:
331340

332341
<!-- x-release-please-start-version -->
333342

334343
```toml
335344
[dependencies]
336-
rust-mcp-sdk = { version = "0.2.0", default-features = false, features = ["client"] }
345+
rust-mcp-sdk = { version = "0.2.0", default-features = false, features = ["client","2024_11_05"] }
337346
```
338347

339348
<!-- x-release-please-end -->

crates/rust-mcp-sdk/README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ This project currently supports following transports:
3535
- [MCP Client (sse)](#mcp-client-sse)
3636
- [Cargo features](#cargo-features)
3737
- [Available Features](#available-features)
38+
- [MCP protocol versions with corresponding features](#mcp-protocol-versions-with-corresponding-features)
3839
- [Default Features](#default-features)
3940
- [Using Only the server Features](#using-only-the-server-features)
4041
- [Using Only the client Features](#using-only-the-client-features)
@@ -298,9 +299,16 @@ The `rust-mcp-sdk` crate provides several features that can be enabled or disabl
298299
- `ssl`: This feature enables TLS/SSL support for the **sse** transport when used with the `hyper-server`.
299300
- `macros`: Provides procedural macros for simplifying the creation and manipulation of MCP Tool structures.
300301

302+
#### MCP Protocol Versions with Corresponding Features
303+
304+
- `2025_03_26` : Activates MCP Protocol version 2025-03-26 (enabled by default)
305+
- `2024_11_05` : Activates MCP Protocol version 2024-11-05
306+
307+
> Note: MCP protocol versions are mutually exclusive—only one can be active at any given time.
308+
301309
### Default Features
302310

303-
All features are enabled by default. When you include rust-mcp-sdk as a dependency without specifying features, all will be included:
311+
When you add rust-mcp-sdk as a dependency without specifying any features, all features are included, with the latest MCP Protocol version enabled by default:
304312

305313
<!-- x-release-please-start-version -->
306314

@@ -327,13 +335,14 @@ Optionally add `hyper-server` for **sse** transport, and `ssl` feature for tls/s
327335

328336
### Using Only the client Features
329337

330-
If you only need the MCP Client functionality, you can disable the default features and explicitly enable the client feature. Add the following to your Cargo.toml:
338+
If you only need the MCP Client functionality, you can disable the default features and explicitly enable the client feature.
339+
Add the following to your Cargo.toml:
331340

332341
<!-- x-release-please-start-version -->
333342

334343
```toml
335344
[dependencies]
336-
rust-mcp-sdk = { version = "0.2.0", default-features = false, features = ["client"] }
345+
rust-mcp-sdk = { version = "0.2.0", default-features = false, features = ["client","2024_11_05"] }
337346
```
338347

339348
<!-- x-release-please-end -->
@@ -393,6 +402,8 @@ Below is a list of projects that utilize the `rust-mcp-sdk`, showcasing their na
393402
| <a href="https://github.com/moonrepo/moon"><img src="https://avatars.githubusercontent.com/u/102833400?s=64" width="64"/></a> | [moon](https://github.com/moonrepo/moon) | moon is a repository management, organization, orchestration, and notification tool for the web ecosystem, written in Rust. | [GitHub](https://github.com/moonrepo/moon) |
394403

395404

405+
406+
396407
## Contributing
397408

398409
We welcome everyone who wishes to contribute! Please refer to the [contributing](CONTRIBUTING.md) guidelines for more details.

0 commit comments

Comments
 (0)