e623f2acab
Use `#![doc = include_str!("../README.md")]` to display README as crate
documentation on docs.rs for both `rmcp` and `rmcp-macros`.
Changes to support this:
- Fix code examples to compile as doc tests (`rust,no_run`)
- Fix broken rustdoc links with explicit `crate::` paths
- Add "Structured Output" section and examples link to rmcp README
- Simplify rmcp-macros README to a summary table with doc links
- Fix grammar throughout
- Add CSS to hide GitHub badges when rendered as rustdoc
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2.3 KiB
2.3 KiB
rmcp-macros
rmcp-macros is a procedural macro library for the Rust Model Context Protocol (RMCP) SDK, providing macros that facilitate the development of RMCP applications.
Available Macros
| Macro | Description |
|---|---|
#[tool] |
Mark a function as an MCP tool handler |
#[tool_router] |
Generate a tool router from an impl block |
#[tool_handler] |
Generate call_tool and list_tools handler methods |
#[prompt] |
Mark a function as an MCP prompt handler |
#[prompt_router] |
Generate a prompt router from an impl block |
#[prompt_handler] |
Generate get_prompt and list_prompts handler methods |
#[task_handler] |
Wire up the task lifecycle on top of an OperationProcessor |
Quick Example
use rmcp::{tool, tool_router, tool_handler, ServerHandler, model::*};
#[derive(Clone)]
struct MyServer {
tool_router: rmcp::handler::server::tool::ToolRouter<Self>,
}
#[tool_router]
impl MyServer {
#[tool(description = "Say hello")]
async fn hello(&self) -> String {
"Hello, world!".into()
}
}
#[tool_handler]
impl ServerHandler for MyServer {
fn get_info(&self) -> ServerInfo {
ServerInfo::default()
}
}
See the full documentation for detailed usage of each macro.
License
Please refer to the LICENSE file in the project root directory.