Skip to content

fix: update crate readme links and docs #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
### 📌 Summary
<!-- Provide a concise description of your changes. What problem does this PR solve? -->

### 🔍 Related Issues
<!-- Link related issues using keywords like "Fixes #123" or "Closes #456" -->

- Fixes #


### ✨ Changes Made
<!-- List the key changes introduced in this PR -->

- Change 1
- Change 2
- Change 3

### 🛠️ Testing Steps
<!-- Explain how reviewers can test your changes, if applicable -->

### 💡 Additional Notes
<!-- Any other information or context about the PR -->
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ Here is the output :

The same principles outlined above apply to the client-side handlers, `mcp_client_handler` and `mcp_client_handler_core`.
Use `client_runtime::create_client()` or `client_runtime_core::create_client()` , respectively.
Check out the corresponding examples at: [examples/simple-mcp-client](https://github.com/rust-mcp-stack/rust-mcp-sdk/tree/main/examples/simple-mcp-client) and [examples/hello-world-mcp-server-core](https://github.com/rust-mcp-stack/rust-mcp-sdk/tree/main/examples/hello-world-mcp-server-core).
Check out the corresponding examples at: [examples/simple-mcp-client](https://github.com/rust-mcp-stack/rust-mcp-sdk/tree/main/examples/simple-mcp-client) and [examples/simple-mcp-client-core](https://github.com/rust-mcp-stack/rust-mcp-sdk/tree/main/examples/simple-mcp-client-core).

## License

Expand Down
2 changes: 1 addition & 1 deletion crates/rust-mcp-macros/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ version = "0.1.0"
authors = ["Ali Hashemi"]
categories = ["data-structures", "parser-implementations", "parsing"]
description = "A procedural macro that derives the MCPToolSchema implementation for structs or enums, generating a tool_input_schema function used with rust_mcp_schema::Tool."
repository = "https://github.com/rust-mcp-stack/rust-mcp-macros"
repository = "https://github.com/rust-mcp-stack/rust-mcp-sdk"
documentation = "https://docs.rs/rust-mcp-macros"
keywords = ["rust-mcp-stack", "model", "context", "protocol", "macros"]
license = "MIT"
Expand Down
4 changes: 2 additions & 2 deletions crates/rust-mcp-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ impl ServerHandler for MyServerHandler {

See hello-world-mcp-server example running in [MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector) :

![mcp-server in rust](https://github.com/rust-mcp-stack/rust-mcp-sdk/tree/main/assets/examples/hello-world-mcp-server.gif)
![mcp-server in rust](assets/examples/hello-world-mcp-server.gif)

---

Expand Down Expand Up @@ -207,7 +207,7 @@ Here is the output :

The same principles outlined above apply to the client-side handlers, `mcp_client_handler` and `mcp_client_handler_core`.
Use `client_runtime::create_client()` or `client_runtime_core::create_client()` , respectively.
Check out the corresponding examples at: [examples/simple-mcp-client](https://github.com/rust-mcp-stack/rust-mcp-sdk/tree/main/examples/simple-mcp-client) and [examples/hello-world-mcp-server-core](https://github.com/rust-mcp-stack/rust-mcp-sdk/tree/main/examples/hello-world-mcp-server-core).
Check out the corresponding examples at: [examples/simple-mcp-client](https://github.com/rust-mcp-stack/rust-mcp-sdk/tree/main/examples/simple-mcp-client) and [examples/simple-mcp-client-core](https://github.com/rust-mcp-stack/rust-mcp-sdk/tree/main/examples/simple-mcp-client-core).

## License

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion crates/rust-mcp-transport/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ version = "0.1.0"
authors = ["Ali Hashemi"]
categories = ["data-structures"]
description = "Transport implementations for the MCP (Model Context Protocol) within the rust-mcp-sdk ecosystem, enabling asynchronous data exchange and efficient message handling between MCP clients and servers."
repository = "https://github.com/rust-mcp-stack/rust-mcp-transport"
repository = "https://github.com/rust-mcp-stack/rust-mcp-sdk"
documentation = "https://docs.rs/rust-mcp-transport"
keywords = ["rust-mcp-stack", "model", "context", "protocol", "sdk"]
license = "MIT"
Expand Down
12 changes: 9 additions & 3 deletions crates/rust-mcp-transport/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# rust-mcp-transport.

`rust-mcp-transport` is a part of the [rust-mcp-sdk](https://github.com/rust-mcp-stack/rust-mcp-sdk) ecosystem, offering transport implementations for the MCP (Model Context Protocol). It enables asynchronous data exchange and efficient MCP message handling between MCP Clients and Servers.
`rust-mcp-transport` is a part of the [rust-mcp-sdk](https://crates.io/crates/rust-mcp-sdk) ecosystem, offering transport implementations for the MCP (Model Context Protocol). It enables asynchronous data exchange and efficient MCP message handling between MCP Clients and Servers.

**⚠️WARNING**: Currently, only Standard Input/Output (stdio) transport is supported. Server-Sent Events (SSE) transport is under development and will be available soon.

Expand All @@ -16,7 +16,7 @@ let transport = StdioTransport::new(TransportOptions { timeout: 60_000 })?;

```

Refer to the [Hello World MCP Server](../../examples/hello-world-mcp-server/) example for a complete demonstration.
Refer to the [Hello World MCP Server](https://github.com/rust-mcp-stack/rust-mcp-sdk/tree/main/examples/hello-world-mcp-server) example for a complete demonstration.

### For MCP Client

Expand Down Expand Up @@ -53,4 +53,10 @@ let transport = StdioTransport::create_with_server_launch(
)?;
```

Refer to the [Simple MCP Client](../../examples/simple-mcp-client/) example for a complete demonstration.
Refer to the [Simple MCP Client](https://github.com/rust-mcp-stack/rust-mcp-sdk/tree/main/examples/simple-mcp-client) example for a complete demonstration.

---

<img align="top" src="assets/rust-mcp-stack-icon.png" width="24" style="border-radius:0.2rem;"> Check out [rust-mcp-sdk](https://crates.io/crates/rust-mcp-sdk) , a high-performance, asynchronous toolkit for building MCP servers and clients. Focus on your app's logic while [rust-mcp-sdk](https://crates.io/crates/rust-mcp-sdk) takes care of the rest!

---
2 changes: 1 addition & 1 deletion examples/hello-world-mcp-server-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ cargo build -p hello-world-mcp-server-core --release

Here you can see it in action :

![hello-world-mcp-server-core](../../assets/examples/hello-world-mcp-server-core.gif)
![hello-world-mcp-server-core]![hello-world-mcp-server](../../assets/examples/hello-world-mcp-server.gif)