chore(docs): Minor README updates (#301)
* chore(docs): minor readme updates * fix: correct typos in changelog
This commit is contained in:
parent
c0f372001f
commit
c6dcbd72e4
3 changed files with 8 additions and 9 deletions
11
README.md
11
README.md
|
|
@ -3,14 +3,12 @@
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
# RMCP
|
# RMCP
|
||||||
Wait for the first release.
|
[](https://crates.io/crates/rmcp)
|
||||||
<!-- [](todo) -->
|
|
||||||
<!--  -->
|
<!--  -->
|
||||||
<!-- [](todo) -->
|
<!-- [](todo) -->
|
||||||

|

|
||||||
|
|
||||||
An official rust Model Context Protocol SDK implementation with tokio async runtime.
|
An official Rust Model Context Protocol SDK implementation with tokio async runtime.
|
||||||
|
|
||||||
|
|
||||||
This repository contains the following crates:
|
This repository contains the following crates:
|
||||||
|
|
||||||
|
|
@ -22,7 +20,7 @@ This repository contains the following crates:
|
||||||
### Import the crate
|
### Import the crate
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
rmcp = { version = "0.1", features = ["server"] }
|
rmcp = { version = "0.2.0", features = ["server"] }
|
||||||
## or dev channel
|
## or dev channel
|
||||||
rmcp = { git = "https://github.com/modelcontextprotocol/rust-sdk", branch = "main" }
|
rmcp = { git = "https://github.com/modelcontextprotocol/rust-sdk", branch = "main" }
|
||||||
```
|
```
|
||||||
|
|
@ -115,7 +113,6 @@ See [examples](examples/README.md)
|
||||||
|
|
||||||
See [oauth_support](docs/OAUTH_SUPPORT.md) for details.
|
See [oauth_support](docs/OAUTH_SUPPORT.md) for details.
|
||||||
|
|
||||||
|
|
||||||
## Related Resources
|
## Related Resources
|
||||||
|
|
||||||
- [MCP Specification](https://spec.modelcontextprotocol.io/specification/2024-11-05/)
|
- [MCP Specification](https://spec.modelcontextprotocol.io/specification/2024-11-05/)
|
||||||
|
|
@ -127,7 +124,9 @@ See [oauth_support](docs/OAUTH_SUPPORT.md) for details.
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
### Tips for Contributors
|
### Tips for Contributors
|
||||||
|
|
||||||
See [docs/CONTRIBUTE.MD](docs/CONTRIBUTE.MD) to get some tips for contributing.
|
See [docs/CONTRIBUTE.MD](docs/CONTRIBUTE.MD) to get some tips for contributing.
|
||||||
|
|
||||||
### Using Dev Container
|
### Using Dev Container
|
||||||
|
|
||||||
If you want to use dev container, see [docs/DEVCONTAINER.md](docs/DEVCONTAINER.md) for instructions on using Dev Container for development.
|
If you want to use dev container, see [docs/DEVCONTAINER.md](docs/DEVCONTAINER.md) for instructions on using Dev Container for development.
|
||||||
|
|
@ -48,5 +48,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||||
- fmt the project ([#54](https://github.com/modelcontextprotocol/rust-sdk/pull/54))
|
- fmt the project ([#54](https://github.com/modelcontextprotocol/rust-sdk/pull/54))
|
||||||
- fix broken link ([#53](https://github.com/modelcontextprotocol/rust-sdk/pull/53))
|
- fix broken link ([#53](https://github.com/modelcontextprotocol/rust-sdk/pull/53))
|
||||||
- fix the branch name for git dependency ([#46](https://github.com/modelcontextprotocol/rust-sdk/pull/46))
|
- fix the branch name for git dependency ([#46](https://github.com/modelcontextprotocol/rust-sdk/pull/46))
|
||||||
- Move whole rmcp crate to offcial rust sdk ([#44](https://github.com/modelcontextprotocol/rust-sdk/pull/44))
|
- Move whole rmcp crate to official rust sdk ([#44](https://github.com/modelcontextprotocol/rust-sdk/pull/44))
|
||||||
- Initial commit
|
- Initial commit
|
||||||
|
|
|
||||||
|
|
@ -72,7 +72,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||||
- add simpling example and test ([#289](https://github.com/modelcontextprotocol/rust-sdk/pull/289))
|
- add simpling example and test ([#289](https://github.com/modelcontextprotocol/rust-sdk/pull/289))
|
||||||
- add update for test_message_schema ([#286](https://github.com/modelcontextprotocol/rust-sdk/pull/286))
|
- add update for test_message_schema ([#286](https://github.com/modelcontextprotocol/rust-sdk/pull/286))
|
||||||
- add notion clear in model.rs ([#284](https://github.com/modelcontextprotocol/rust-sdk/pull/284))
|
- add notion clear in model.rs ([#284](https://github.com/modelcontextprotocol/rust-sdk/pull/284))
|
||||||
- cov settings, and fix serveral building warnings ([#281](https://github.com/modelcontextprotocol/rust-sdk/pull/281))
|
- cov settings, and fix several building warnings ([#281](https://github.com/modelcontextprotocol/rust-sdk/pull/281))
|
||||||
- refactor tool macros and router implementation ([#261](https://github.com/modelcontextprotocol/rust-sdk/pull/261))
|
- refactor tool macros and router implementation ([#261](https://github.com/modelcontextprotocol/rust-sdk/pull/261))
|
||||||
- fix regression in URL joining ([#265](https://github.com/modelcontextprotocol/rust-sdk/pull/265))
|
- fix regression in URL joining ([#265](https://github.com/modelcontextprotocol/rust-sdk/pull/265))
|
||||||
- remove erroneous definitions_path ([#264](https://github.com/modelcontextprotocol/rust-sdk/pull/264))
|
- remove erroneous definitions_path ([#264](https://github.com/modelcontextprotocol/rust-sdk/pull/264))
|
||||||
|
|
@ -104,5 +104,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||||
- *(sse_server)* separate router and server startup ([#52](https://github.com/modelcontextprotocol/rust-sdk/pull/52))
|
- *(sse_server)* separate router and server startup ([#52](https://github.com/modelcontextprotocol/rust-sdk/pull/52))
|
||||||
- fix broken link ([#53](https://github.com/modelcontextprotocol/rust-sdk/pull/53))
|
- fix broken link ([#53](https://github.com/modelcontextprotocol/rust-sdk/pull/53))
|
||||||
- fix the branch name for git dependency ([#46](https://github.com/modelcontextprotocol/rust-sdk/pull/46))
|
- fix the branch name for git dependency ([#46](https://github.com/modelcontextprotocol/rust-sdk/pull/46))
|
||||||
- Move whole rmcp crate to offcial rust sdk ([#44](https://github.com/modelcontextprotocol/rust-sdk/pull/44))
|
- Move whole rmcp crate to official rust sdk ([#44](https://github.com/modelcontextprotocol/rust-sdk/pull/44))
|
||||||
- Initial commit
|
- Initial commit
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue