ready for creates

Author: LishuaiJing3

mcp-rust-server/Cargo.toml

@@ -2,32 +2,36 @@
 name = "mcp-rust-server"
 version = "0.1.0"
 edition = "2021"
-authors = ["Lishuai Jing <lishuai@syncable.dev>, Alex Holmberg<axth@syncable.dev>"]
+authors = [
+    "Lishuai Jing <lishuai@syncable.dev>",
+    "Alex Holmberg <axth@syncable.dev>",
+]
 description = "High-performance Model Context Protocol (MCP) server for code analysis, security scanning, and project insights."
 license = "MIT"
 repository = "https://github.com/syncable-dev/syncable-cli-mcp-server"
+homepage = "https://github.com/syncable-dev/syncable-cli-mcp-server"
+documentation = "https://docs.rs/mcp-rust-server"
 readme = "README.md"
 
+# crates.io discoverability
 keywords = [
-    "mcp",
-    "mcp-server",
-    "AI-agents",
-    "cli",
-    "infrastructure",
-    "devops",
+    "mcp", "mcp-server", "AI-agents", "cli",
+    "devops", "infrastructure", "security", "analysis",
+    "scan", "automation", "rust"
+]
+categories = [
+    "command-line-utilities",
+    "network-programming",
     "security",
-    "analysis",
-    "scan",
-    "automation",
-    "rust"
+    "web-programming",
+    "infrastructure"
 ]
 
 [dependencies]
-# MCP server dependencies
 async-trait = "0.1.88"
 rust-mcp-sdk = "0.4.3"
 tracing = "0.1.41"
-tracing-subscriber = { version = "0.3.19", features = ["fmt","env-filter"] }
+tracing-subscriber = { version = "0.3.19", features = ["fmt", "env-filter"] }
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 tokio = { version = "1", features = ["full"] }
@@ -57,4 +61,3 @@ opt-level = 3
 lto = true
 codegen-units = 1
 panic = "abort"
-

mcp-rust-server/README.md

@@ -1,90 +1,162 @@
-# 🦀 MCP Rust Server
+# mcp-rust-server
 
-> High-performance Model Context Protocol (MCP) server for code analysis, security scanning, and project insights.
+[![Crates.io](https://img.shields.io/crates/v/mcp-rust-server.svg?style=for-the-badge)](https://crates.io/crates/mcp-rust-server)
+[![Docs.rs](https://img.shields.io/docsrs/mcp-rust-server?style=for-the-badge)](https://docs.rs/mcp-rust-server)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge)](LICENSE)
 
-[![Rust](https://img.shields.io/badge/rust-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white)](https://www.rust-lang.org/)
-[![Crates.io](https://img.shields.io/crates/v/mcp-rust-server?style=for-the-badge)](https://crates.io/crates/mcp-rust-server)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](../LICENSE)
+High-performance **Model Context Protocol** (MCP) server for code analysis, security scanning, and project insights—written in Rust 🦀.
 
 ---
 
-## ✨ Features
+## Table of Contents
 
-- **Fast & Scalable**: Built with async Rust for maximum performance
-- **Flexible Protocols**: Supports both stdio and SSE communication
-- **Security & Vulnerability Scanning**: Analyze codebases for risks and vulnerabilities
-- **Extensible**: Add new handlers and endpoints easily
-- **Production Ready**: Optimized release profile and logging
+* [Features](#features)
+* [Installation](#installation)
+
+  * [CLI Binaries](#cli-binaries)
+  * [Library](#library)
+* [Usage](#usage)
+* [Examples](#examples)
+* [Documentation](#documentation)
+* [Contributing](#contributing)
+* [License](#license)
+* [Acknowledgments](#acknowledgments)
 
 ---
 
-## 🚀 Quick Start
+## Features
 
-### Build
+* **Fast & Scalable**: Built with async Rust on the Tokio runtime
+* **Multi-Protocol**: Supports both stdio and SSE (Server-Sent Events) transports
+* **Security Scanning**: Static analysis and vulnerability detection
+* **Extensible**: Easily add new MCP handlers and custom tools
+* **Production-Ready**: Optimized release profile, structured logging, and CI integration
 
-```bash
-cargo build --release
-```
+---
 
-### Run (Stdio Mode)
+## Installation
+
+mcp-rust-server is published on [crates.io]. You need a recent Rust toolchain (1.70+ recommended).
+
+### CLI Binaries
 
 ```bash
-cargo run --release --bin mcp-stdio
+cargo install mcp-rust-server
 ```
 
-### Run (SSE Mode)
+This installs two binaries into your Cargo `bin` directory (usually `~/.cargo/bin`):
 
-```bash
-cargo run --release --bin mcp-sse
+* `mcp-stdio` — stdin/stdout-based MCP server
+* `mcp-sse`   — HTTP/SSE-based MCP server
+
+### Library
+
+Add to your project’s `Cargo.toml`:
+
+```toml
+[dependencies]
+mcp-rust-server = "0.1.0"
 ```
 
 ---
 
-## 📦 Installation (from crates.io)
+## Usage
+
+### CLI Binaries
 
 ```bash
-cargo install mcp-rust-server
+# Run the stdio-based server
+mcp-stdio
+
+# Run the SSE-based server
+mcp-sse
+```
+
+By default, both servers will:
+
+1. Read framed MCP requests (JSON-RPC) from the chosen transport
+2. Dispatch to your registered handlers
+3. Write framed MCP responses
+
+### Library
+
+```rust
+use mcp_rust_server::{start_stdio, start_sse};
+
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    // Run as a stdio server
+    start_stdio().await?;
+
+    // Or run as an HTTP/SSE server
+    // start_sse().await?;
+
+    Ok(())
+}
 ```
 
+* `start_stdio()` initializes logging, registers tools, and listens on stdin/stdout.
+* `start_sse()` spins up an HTTP server at `http://0.0.0.0:8000/mcp` and streams MCP responses.
+
 ---
 
-## 🛠️ Usage
+## Examples
+
+See the \[`examples/`] directory for full end-to-end demos:
 
-- Use as a standalone server for MCP protocol
-- Integrate with Syncable CLI or other tools
-- Communicate via stdio or SSE endpoints
+* `examples/stdio_client.rs` — launch `mcp-stdio` and send sample requests
+* `examples/sse_client.html` — web page that connects to `mcp-sse` and renders events
 
 ---
 
-## 🧪 Testing
+## Documentation
+
+Full API documentation is generated on [docs.rs]:
 
 ```bash
-cargo test
+cargo doc --open
 ```
 
+Or browse online:
+[https://docs.rs/mcp-rust-server](https://docs.rs/mcp-rust-server)
+
 ---
 
-## 📄 License
+## Contributing
 
-MIT License - see [LICENSE](../LICENSE) for details.
+Contributions are welcome! Please:
 
----
+1. Fork the repo
+2. Create a feature branch (`git checkout -b feat/your-feature`)
+3. Commit your changes (`git commit -m "Add feature"`)
+4. Push to your fork (`git push origin feat/your-feature`)
+5. Open a pull request
 
-## 🤝 Contributing
+Run tests and lint before submitting:
 
-Contributions are welcome! Please open issues or pull requests for improvements.
+```bash
+cargo test
+cargo fmt -- --check
+cargo clippy -- -D warnings
+```
 
 ---
 
-## 📚 Documentation
+## License
 
-- See the main project [README](../README.md) for integration and usage examples.
-- API docs: Run `cargo doc --open`
+Licensed under the [MIT License]. See \[LICENSE] for details.
 
 ---
 
-## Ref
-- [Rust-mcp-sdk](https://lib.rs/crates/rust-mcp-sdk)
-- [Release tool](https://github.com/release-plz/release-plz)
+## Acknowledgments
+
+* Built on top of the [rust-mcp-sdk]
+* Inspired by the [Syncable CLI MCP Server]
+* Thanks to the Rust community and all contributors
 
-**Built with Rust 🦀 and the open-source community.**
+[crates.io]: https://crates.io/crates/mcp-rust-server
+[docs.rs]: https://docs.rs/mcp-rust-server
+[examples/]: https://github.com/syncable-dev/syncable-cli-mcp-server/tree/main/examples
+[MIT License]: LICENSE
+[rust-mcp-sdk]: https://crates.io/crates/rust-mcp-sdk
+[Syncable CLI MCP Server]: https://github.com/syncable-dev/syncable-cli-mcp-server