Skip to content

Commit b1bfbfc

Browse files
committed
docs: improve READMEs with GitHub callouts and consistent structure
- Add GitHub callouts ([!IMPORTANT], [!TIP], [!NOTE], [!WARNING]) - Standardize badge format (crates.io, docs.rs, MSRV, License) - Add MSRV Policy section to all crate READMEs - Simplify content, reduce duplication (-236 lines total) - Add pre-built binary installation instructions
1 parent 39e735e commit b1bfbfc

File tree

7 files changed

+321
-557
lines changed

7 files changed

+321
-557
lines changed

README.md

Lines changed: 44 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
# MCP Code Execution
22

3-
> **Autonomous MCP Tool Execution with 98% Token Savings**
4-
>
5-
> Transform any MCP server into executable, type-safe TypeScript tools using progressive loading pattern. Load only what you need, when you need it.
6-
73
[![CI](https://github.com/bug-ops/mcp-execution/actions/workflows/ci.yml/badge.svg)](https://github.com/bug-ops/mcp-execution/actions/workflows/ci.yml)
84
[![codecov](https://codecov.io/gh/bug-ops/mcp-execution/branch/master/graph/badge.svg)](https://codecov.io/gh/bug-ops/mcp-execution)
95
[![MSRV](https://img.shields.io/badge/MSRV-1.89-blue.svg)](https://blog.rust-lang.org/2025/01/23/Rust-1.89.0.html)
10-
[![License](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg)](LICENSE)
6+
[![License](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg)](LICENSE.md)
7+
8+
Transform any MCP server into executable, type-safe TypeScript tools using progressive loading pattern. Achieve **98% token savings** by loading only what you need.
9+
10+
> [!TIP]
11+
> Inspired by [Anthropic's engineering blog post](https://www.anthropic.com/engineering/code-execution-with-mcp) on Code Execution with MCP.
1112
1213
## The Problem
1314

@@ -19,20 +20,36 @@ Progressive loading generates one TypeScript file per tool (~500-1,500 tokens ea
1920

2021
**Result**: **98% token savings** + **autonomous execution** + **type safety**
2122

22-
> Inspired by [Anthropic's engineering blog post](https://www.anthropic.com/engineering/code-execution-with-mcp) on Code Execution with MCP.
23+
## Installation
2324

24-
## Quick Start
25+
### Pre-built binaries
2526

26-
### Installation
27+
Download from [GitHub Releases](https://github.com/bug-ops/mcp-execution/releases/latest):
2728

2829
```bash
29-
# Pre-built binaries
30+
# macOS (Apple Silicon)
3031
curl -L https://github.com/bug-ops/mcp-execution/releases/latest/download/mcp-execution-cli-macos-arm64.tar.gz | tar xz
3132

32-
# From source
33+
# macOS (Intel)
34+
curl -L https://github.com/bug-ops/mcp-execution/releases/latest/download/mcp-execution-cli-macos-amd64.tar.gz | tar xz
35+
36+
# Linux (x86_64)
37+
curl -L https://github.com/bug-ops/mcp-execution/releases/latest/download/mcp-execution-cli-linux-amd64.tar.gz | tar xz
38+
```
39+
40+
### From source
41+
42+
```bash
43+
git clone https://github.com/bug-ops/mcp-execution
44+
cd mcp-execution
3345
cargo install --path crates/mcp-cli
3446
```
3547

48+
> [!IMPORTANT]
49+
> Requires Rust 1.89 or later.
50+
51+
## Usage
52+
3653
### Generate TypeScript Tools
3754

3855
```bash
@@ -46,7 +63,7 @@ mcp-execution-cli generate --from-config github
4663
# - ... (one file per tool)
4764
```
4865

49-
### Use Progressive Loading
66+
### Progressive Loading
5067

5168
```bash
5269
# List available tools
@@ -59,6 +76,9 @@ cat ~/.claude/servers/github/createIssue.ts
5976
node ~/.claude/servers/github/createIssue.ts --repo="owner/repo" --title="Bug"
6077
```
6178

79+
> [!NOTE]
80+
> Each tool file is self-contained with full TypeScript interfaces and JSDoc documentation.
81+
6282
## Key Features
6383

6484
| Feature | Description |
@@ -80,8 +100,9 @@ node ~/.claude/servers/github/createIssue.ts --repo="owner/repo" --title="Bug"
80100
| [mcp-server](crates/mcp-server) | MCP server for progressive loading generation |
81101
| [mcp-cli](crates/mcp-cli) | Command-line interface |
82102

83-
**Dependency Graph** (no circular dependencies):
84-
```
103+
**Dependency Graph**:
104+
105+
```text
85106
mcp-cli → {mcp-codegen, mcp-introspector, mcp-files, mcp-core}
86107
mcp-server → {mcp-codegen, mcp-introspector, mcp-files, mcp-core}
87108
mcp-codegen → {mcp-files, mcp-core}
@@ -121,48 +142,25 @@ mcp-execution-cli completions bash
121142
- [Progressive Loading Tutorial](examples/progressive-loading-usage.md) - Complete guide
122143
- [Claude Code Integration](examples/SKILL.md) - Skill setup
123144
- [Architecture Decisions](docs/adr/) - ADRs explaining design choices
124-
- [API Documentation](https://docs.rs/mcp-execution) - Rust API docs
125145

126146
## Development
127147

128148
```bash
129-
# Build
130-
cargo build --workspace
131-
132-
# Test
133-
cargo nextest run --workspace
134-
135-
# Lint
136-
cargo clippy --workspace -- -D warnings
137-
138-
# Format
139-
cargo +nightly fmt --workspace
149+
cargo build --workspace # Build
150+
cargo nextest run --workspace # Test
151+
cargo clippy --workspace # Lint
152+
cargo +nightly fmt --workspace # Format
140153
```
141154

142-
All development follows [Microsoft Rust Guidelines](https://microsoft.github.io/rust-guidelines/).
155+
> [!NOTE]
156+
> All development follows [Microsoft Rust Guidelines](https://microsoft.github.io/rust-guidelines/).
143157
144-
## Security
158+
## MSRV Policy
145159

146-
- **No code execution during generation**: Generated TypeScript is static
147-
- **Input validation**: All parameters validated before use
148-
- **Path safety**: Validated to prevent directory traversal
149-
- **Template security**: Handlebars escapes all user input
160+
Minimum Supported Rust Version: **1.89**
150161

151-
## Contributing
152-
153-
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
162+
MSRV increases are considered minor version bumps.
154163

155164
## License
156165

157-
Licensed under either of:
158-
159-
- **Apache License, Version 2.0** ([LICENSE-APACHE](LICENSE))
160-
- **MIT license** ([LICENSE-MIT](LICENSE))
161-
162-
at your option.
163-
164-
## Resources
165-
166-
- [MCP Specification](https://spec.modelcontextprotocol.io/) - Protocol specification
167-
- [rmcp Documentation](https://docs.rs/rmcp) - Official Rust MCP SDK
168-
- [Code Execution with MCP](https://www.anthropic.com/engineering/code-execution-with-mcp) - Original inspiration
166+
Licensed under either of [Apache License 2.0](LICENSE.md) or [MIT license](LICENSE.md) at your option.

0 commit comments

Comments
 (0)