Skip to content
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

Reorganise? #6

Open
itsaphel opened this issue Feb 26, 2025 · 7 comments
Open

Reorganise? #6

itsaphel opened this issue Feb 26, 2025 · 7 comments

Comments

@itsaphel
Copy link

itsaphel commented Feb 26, 2025

May I gently suggest moving crates/mcp-client and crates/mcp-server to the examples directory? As they seem to be like sample implementations one could use, but are not actually part of the library as far as I can tell.

@jlvihv
Copy link

jlvihv commented Feb 26, 2025

Can someone come out and say a word? I agree with you. And it seems that the Router / Server / ByteTransport / BoundedService in crates/mcp-server and those defined errors should be moved to core to give the user a cleaner and leaner code example, can we do anything for this repository?

@baxen
Copy link
Contributor

baxen commented Feb 27, 2025

The mcp-client and mcp-server are intended to be the dependencies that downstream crates would use directly! mcp-core is for shared content between both, mostly the types used in messages. The intent is that you can grab either client or server depending on what you need

@AdamSimpson
Copy link

AdamSimpson commented Feb 28, 2025

Just wanted to gently third that I find this repo quite confusing. As a rust developer I find offeryn has a familiar layout, with a top level examples directory containing projects demonstrating how to use the crate. I've spent a few minutes looking at #8 and am honestly still not quite sure how to use this library efficiently.

@baxen
Copy link
Contributor

baxen commented Feb 28, 2025

Yes we're overdue for examples and documentation! The layout across a few crates (similar to offeryn) I think is somewhat necessary, but we'll add top level examples to make this clear

@itsaphel
Copy link
Author

Shouldn't https://github.com/modelcontextprotocol/rust-sdk/blob/main/crates/mcp-server/src/main.rs at least be an example, since it's a particular usage of an mcp-server (a counter server), showing how the library should be used?

@WSL0809
Copy link

WSL0809 commented Mar 2, 2025

Yes we're overdue for examples and documentation! The layout across a few crates (similar to offeryn) I think is somewhat necessary, but we'll add top level examples to make this clear是的,我们确实需要提供示例和文档了!虽然跨多个 crate 的布局(类似于 offeryn )是必要的,但我们会添加顶层示例来让这一点更加清晰

I completely agree with clearly documenting the project's examples and roadmap in the README.

@baxen
Copy link
Contributor

baxen commented Mar 14, 2025

Pausing this reorganization for a second so we can coordinate several other MCP builders who have reached out

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants