Skip to content

Commit a5e9d2d

Browse files
LishuaiJing3LishuaiJing3
committed
add yaml
1 parent b89ffe8 commit a5e9d2d

3 files changed

Lines changed: 204 additions & 2 deletions

File tree

‎.github/dependabot.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: "cargo"
9+
directory: "/" # Location of Cargo.toml and Cargo.lock
10+
schedule:
11+
interval: "weekly"
12+
target-branch: "develop"

‎.github/workflows/release-plz.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Release-plz
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
release-plz-release:
10+
name: Release-plz release
11+
runs-on: ubuntu-latest
12+
if: ${{ github.repository_owner == 'syncable-dev' }}
13+
permissions:
14+
contents: write
15+
steps:
16+
- name: Checkout repository
17+
uses: actions/checkout@v4
18+
with:
19+
fetch-depth: 0
20+
token: ${{ secrets.RELEASE_PLZ_TOKEN }}
21+
- name: Install Rust toolchain
22+
uses: dtolnay/rust-toolchain@stable
23+
- name: Run release-plz
24+
uses: release-plz/action@v0.5
25+
with:
26+
command: release
27+
env:
28+
GITHUB_TOKEN: ${{ secrets.RELEASE_PLZ_TOKEN }}
29+
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
30+
31+
release-plz-pr:
32+
name: Release-plz PR
33+
runs-on: ubuntu-latest
34+
if: ${{ github.repository_owner == 'syncable-dev' }}
35+
permissions:
36+
pull-requests: write
37+
contents: write
38+
concurrency:
39+
group: release-plz-${{ github.ref }}
40+
cancel-in-progress: false
41+
steps:
42+
- name: Checkout repository
43+
uses: actions/checkout@v4
44+
with:
45+
fetch-depth: 0
46+
token: ${{ secrets.RELEASE_PLZ_TOKEN }}
47+
- name: Install Rust toolchain
48+
uses: dtolnay/rust-toolchain@stable
49+
- name: Run release-plz
50+
uses: release-plz/action@v0.5
51+
with:
52+
command: release-pr
53+
env:
54+
GITHUB_TOKEN: ${{ secrets.RELEASE_PLZ_TOKEN }}
55+
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}cl

‎README.md‎

Lines changed: 137 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,137 @@
1-
# syncable-cli-mcp-server
2-
MCP server for syncable cli which scans code repo for security risks, vulnerabilities and project overview.
1+
# 🚀 Syncable MCP Server & Python Client
2+
3+
> High-performance Model Context Protocol (MCP) server in Rust with a Python client for seamless integration and rapid prototyping.
4+
5+
[![Rust](https://img.shields.io/badge/rust-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white)](https://www.rust-lang.org/)
6+
[![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)](https://www.python.org/)
7+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
8+
9+
---
10+
11+
## ⚡ Quick Start
12+
13+
### 1. Build & Run the Rust MCP Server
14+
15+
```bash
16+
cd mcp-rust-server
17+
cargo build --release
18+
./target/release/mcp-stdio # or ./target/release/mcp-sse for SSE mode
19+
```
20+
21+
### 2. Use the Python Client
22+
23+
```bash
24+
cd mcp-python-server-client
25+
uv sync
26+
27+
# Example usage
28+
uv run python -m src.mcp_py_client_rust_server_stdio
29+
```
30+
31+
---
32+
33+
## 🎯 What This Project Does
34+
35+
- **MCP Rust Server**: Fast, scalable server implementing the Model Context Protocol (MCP) for code analysis, LLM integration, and more.
36+
- **Python Client**: Easy-to-use Python interface for communicating with the Rust server via stdio or SSE.
37+
- **Multi-language**: Designed for integration with various tools and languages.
38+
39+
---
40+
41+
## 📋 Key Features
42+
43+
- 🚀 **Blazing Fast**: Rust-powered backend for maximum performance
44+
- 🔌 **Flexible Protocols**: Supports both stdio and SSE communication
45+
- 🐍 **Python Client**: Simple API for rapid prototyping and integration
46+
- 🛡️ **Secure**: Built with modern Rust safety guarantees
47+
- 🧩 **Extensible**: Easy to add new handlers and endpoints
48+
49+
---
50+
51+
## 🛠️ Installation
52+
53+
### Rust Server
54+
55+
```bash
56+
cd mcp-rust-server
57+
cargo build --release
58+
```
59+
60+
### Python Client
61+
62+
```bash
63+
cd mcp-python-server-client
64+
pip install -e . # or pip install .
65+
```
66+
67+
---
68+
69+
## 📖 Usage Guide
70+
71+
### Start the Rust Server
72+
73+
```bash
74+
cd mcp-rust-server
75+
./target/release/mcp-stdio
76+
```
77+
78+
Or for SSE mode:
79+
80+
```bash
81+
./target/release/mcp-sse
82+
```
83+
84+
### Use the Python Client
85+
86+
```python
87+
from mcp_py_client_rust_server_stdio import main as run_client
88+
run_client()
89+
```
90+
91+
Or run the provided scripts directly:
92+
93+
```bash
94+
uv run python -m src.mcp_py_client_rust_server_stdio
95+
```
96+
97+
---
98+
99+
## 🧪 Development & Testing
100+
101+
### Rust
102+
103+
```bash
104+
cd mcp-rust-server
105+
cargo test
106+
cargo clippy
107+
cargo fmt
108+
```
109+
110+
### Python
111+
112+
```bash
113+
cd mcp-python-server-client
114+
pytest
115+
```
116+
117+
---
118+
119+
## 🤝 Contributing
120+
121+
We welcome contributions! Please open issues or pull requests. For major changes, open an issue first to discuss what you’d like to change.
122+
123+
---
124+
125+
## 📄 License
126+
127+
MIT License - see [LICENSE](LICENSE) for details.
128+
129+
---
130+
131+
## 🙏 Acknowledgments
132+
133+
Built with Rust 🦀 and Python 🐍, powered by the open-source community.
134+
135+
---
136+
137+
**Need help?** Check the `docs/` folder or open an issue.

0 commit comments

Comments
 (0)