Skip to content

Commit 4f8a5b7

Browse files
authored
fix: update crate readme links and docs (#2)
* fix: update crate info and readme files * chore: add pull request template * fix: asset link * fix: update readme
1 parent 6dbbb7d commit 4f8a5b7

File tree

9 files changed

+36
-9
lines changed

9 files changed

+36
-9
lines changed

.github/pull_request_template.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
### 📌 Summary
2+
<!-- Provide a concise description of your changes. What problem does this PR solve? -->
3+
4+
### 🔍 Related Issues
5+
<!-- Link related issues using keywords like "Fixes #123" or "Closes #456" -->
6+
7+
- Fixes #
8+
9+
10+
### ✨ Changes Made
11+
<!-- List the key changes introduced in this PR -->
12+
13+
- Change 1
14+
- Change 2
15+
- Change 3
16+
17+
### 🛠️ Testing Steps
18+
<!-- Explain how reviewers can test your changes, if applicable -->
19+
20+
### 💡 Additional Notes
21+
<!-- Any other information or context about the PR -->

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ Here is the output :
207207

208208
The same principles outlined above apply to the client-side handlers, `mcp_client_handler` and `mcp_client_handler_core`.
209209
Use `client_runtime::create_client()` or `client_runtime_core::create_client()` , respectively.
210-
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).
210+
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).
211211

212212
## License
213213

crates/rust-mcp-macros/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ version = "0.1.0"
44
authors = ["Ali Hashemi"]
55
categories = ["data-structures", "parser-implementations", "parsing"]
66
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."
7-
repository = "https://github.com/rust-mcp-stack/rust-mcp-macros"
7+
repository = "https://github.com/rust-mcp-stack/rust-mcp-sdk"
88
documentation = "https://docs.rs/rust-mcp-macros"
99
keywords = ["rust-mcp-stack", "model", "context", "protocol", "macros"]
1010
license = "MIT"

crates/rust-mcp-sdk/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ impl ServerHandler for MyServerHandler {
102102

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

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

107107
---
108108

@@ -207,7 +207,7 @@ Here is the output :
207207

208208
The same principles outlined above apply to the client-side handlers, `mcp_client_handler` and `mcp_client_handler_core`.
209209
Use `client_runtime::create_client()` or `client_runtime_core::create_client()` , respectively.
210-
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).
210+
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).
211211

212212
## License
213213

Loading
Loading

crates/rust-mcp-transport/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ version = "0.1.0"
44
authors = ["Ali Hashemi"]
55
categories = ["data-structures"]
66
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."
7-
repository = "https://github.com/rust-mcp-stack/rust-mcp-transport"
7+
repository = "https://github.com/rust-mcp-stack/rust-mcp-sdk"
88
documentation = "https://docs.rs/rust-mcp-transport"
99
keywords = ["rust-mcp-stack", "model", "context", "protocol", "sdk"]
1010
license = "MIT"

crates/rust-mcp-transport/README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# rust-mcp-transport.
22

3-
`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.
3+
`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.
44

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

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

1717
```
1818

19-
Refer to the [Hello World MCP Server](../../examples/hello-world-mcp-server/) example for a complete demonstration.
19+
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.
2020

2121
### For MCP Client
2222

@@ -53,4 +53,10 @@ let transport = StdioTransport::create_with_server_launch(
5353
)?;
5454
```
5555

56-
Refer to the [Simple MCP Client](../../examples/simple-mcp-client/) example for a complete demonstration.
56+
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.
57+
58+
---
59+
60+
<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!
61+
62+
---

examples/hello-world-mcp-server-core/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ cargo build -p hello-world-mcp-server-core --release
3131

3232
Here you can see it in action :
3333

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

0 commit comments

Comments
 (0)