diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dc889eb..d327f2c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,3 @@ -Here’s a summarized and rephrased version of your contribution guide: - --- # **Contributing to rust-mcp-schema** diff --git a/README.md b/README.md index fa5a35c..c82f652 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,19 @@ A type-safe implementation of the official Model Context Protocol (MCP) schema i The MCP schemas in this repository are [automatically generated](#how-are-schemas-generated) from the official Model Context Protocol, ensuring they are always up-to-date and aligned with the latest official specifications. +--- +**Note:** This crate **only** provides an implementation of the MCP schema. + + If you are looking for a high-performance, asynchronous toolkit for building MCP servers and clients, checkout [rust-mcp-sdk](https://crates.io/crates/rust-mcp-sdk). +Focus on your app's logic while [rust-mcp-sdk](https://crates.io/crates/rust-mcp-sdk) takes care of the rest! + +--- + ## Contents: - [Features](#features) - [How can this crate be used?](#how-can-this-crate-be-used) -- [What is not included in this crate?](#%EF%B8%8F-what-is-not-included-in-this-crate) + - [Schema Versions](#schema-versions) - [Currently available versions](#currently-available-versions) - [How to switch between different schema versions?](#how-to-switch-between-different-schema-versions) @@ -49,15 +57,14 @@ Model Context Protocol (MCP) is an open protocol that enables seamless integrati This crate includes the schema with `serialization` / `deserialization` support via serde_json, along with a minimal implementation of the necessary traits for structs and enums. This helps in creating and using various MCP messages such as requests, responses, notifications, and errors. -This crate could be used for developing an **MCP Server**, **MCP Client**, or even an **MCP Host** in Rust. +This crate could be used for developing an **MCP Server** or **MCP Client** in Rust. For more information on the MCP architecture, refer to the [official documentation](https://spec.modelcontextprotocol.io/specification). -## ⚠️ What is not included in this crate? +--- -This crate **only** provides an implementation of the MCP schema. -This crate is not intended to provide an MCP Transport implementation for sending and receiving MCP messages. + Check out [rust-mcp-sdk](https://crates.io/crates/rust-mcp-sdk) , a high-performance, asynchronous toolkit for building MCP servers and clients which is based on `rust-mcp-schema`. Focus on your app's logic while [rust-mcp-sdk](https://crates.io/crates/rust-mcp-sdk) takes care of the rest! -That said, we are actively developing a lightweight, memory-efficient asynchronous MCP SDK. This will offer seamless integration with rust-mcp-schema, making it easier for you to build your own MCP Server and MCP Client. Stay tuned for updates, and we appreciate your support! +--- ## Schema Versions diff --git a/assets/rust-mcp-schema.png b/assets/rust-mcp-schema.png index ac122f6..554e653 100644 Binary files a/assets/rust-mcp-schema.png and b/assets/rust-mcp-schema.png differ diff --git a/assets/rust-mcp-stack-icon.png b/assets/rust-mcp-stack-icon.png new file mode 100644 index 0000000..4f18cd1 Binary files /dev/null and b/assets/rust-mcp-stack-icon.png differ