Skip to content

Commit 0792977

Browse files
committed
Update README.md
1 parent 778f592 commit 0792977

File tree

1 file changed

+47
-47
lines changed

1 file changed

+47
-47
lines changed

README.md

Lines changed: 47 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 🚀 Code Mode UTCP
1+
# Code Mode UTCP
22

33
[![npm](https://img.shields.io/npm/v/@utcp/code-mode)](https://www.npmjs.com/package/@utcp/code-mode)
44
![npm downloads](https://img.shields.io/npm/dt/@utcp/code-mode)
@@ -7,17 +7,17 @@
77
> **The first plug-and-play library that enables Code Mode tool execution locally.**
88
> Transform your AI agents from clunky tool callers into efficient code executors — in just 3 lines.
99
10-
## Why This Changes Everything
10+
## Why This Changes Everything
1111

12-
**Research from [Cloudflare](https://blog.cloudflare.com/code-mode/) and [Anthropic](https://www.anthropic.com/engineering/code-execution-with-mcp) proves:**
12+
**Research from [Apple](https://machinelearning.apple.com/research/codeact), [Cloudflare](https://blog.cloudflare.com/code-mode/) and [Anthropic](https://www.anthropic.com/engineering/code-execution-with-mcp) proves:**
1313
- **60% faster execution** than traditional tool calling
1414
- **68% fewer tokens** consumed
1515
- **88% fewer API round trips**
1616
- **98.7% reduction in context overhead** for complex workflows
1717

1818
**The insight:** LLMs excel at writing code but struggle with tool calls. Instead of exposing hundreds of tools directly, give them ONE tool that executes TypeScript code with access to your entire toolkit.
1919

20-
## 📊 Comprehensive Benchmarks
20+
## Comprehensive Benchmarks
2121

2222
Independent [Python benchmark study](https://github.com/imran31415/codemode_python_benchmark) validates the performance claims with **$9,536/year cost savings** at 1,000 scenarios/day:
2323

@@ -29,13 +29,13 @@ Independent [Python benchmark study](https://github.com/imran31415/codemode_pyth
2929

3030
### **Why Code Mode Dominates:**
3131

32-
🔄 **Batching Advantage** - Single code block replaces multiple API calls
33-
🧠 **Cognitive Efficiency** - LLMs excel at code generation vs. tool orchestration
34-
**Computational Efficiency** - No context re-processing between operations
32+
**Batching Advantage** - Single code block replaces multiple API calls
33+
**Cognitive Efficiency** - LLMs excel at code generation vs. tool orchestration
34+
**Computational Efficiency** - No context re-processing between operations
3535

3636
**Real-world results:** Independent benchmarks demonstrate significant cost savings, with **$9,536/year savings** possible at enterprise scale (1,000 scenarios/day).
3737

38-
## 🎯 Get Started in 3 Lines
38+
## Get Started in 3 Lines
3939

4040
```typescript
4141
import { CodeModeUtcpClient } from '@utcp/code-mode';
@@ -47,7 +47,7 @@ const { result } = await client.callToolChain(`/* TypeScript */`); // 3. Execu
4747

4848
That's it. Your AI agent can now execute complex workflows in a single request instead of dozens.
4949

50-
## 🔥 What You Get
50+
## What You Get
5151

5252
### **Progressive Tool Discovery**
5353
```typescript
@@ -88,15 +88,15 @@ namespace github {
8888
}
8989
```
9090

91-
## 🛡️ Enterprise-Ready
91+
## Enterprise-Ready
9292

93-
- **🔒 Secure VM Sandboxing** – Node.js isolates prevent unauthorized access
94-
- **⏱️ Timeout Protection** – Configurable execution limits prevent runaway code
95-
- **📊 Complete Observability** – Full console output capture and error handling
96-
- **🎯 Zero External Dependencies** – Tools only accessible through registered UTCP/MCP servers
97-
- **🔍 Runtime Introspection** – Dynamic interface discovery for adaptive workflows
93+
- **Secure VM Sandboxing** – Node.js isolates prevent unauthorized access
94+
- **Timeout Protection** – Configurable execution limits prevent runaway code
95+
- **Complete Observability** – Full console output capture and error handling
96+
- **Zero External Dependencies** – Tools only accessible through registered UTCP/MCP servers
97+
- **Runtime Introspection** – Dynamic interface discovery for adaptive workflows
9898

99-
## 🌍 Universal Protocol Support
99+
## Universal Protocol Support
100100

101101
Works with **any tool ecosystem:**
102102

@@ -113,7 +113,7 @@ Works with **any tool ecosystem:**
113113
npm install @utcp/code-mode
114114
```
115115

116-
## 🎉 Even Easier: Ready-to-Use MCP Server
116+
## Even Easier: Ready-to-Use MCP Server
117117

118118
**Want Code Mode without any setup?** Use our plug-and-play MCP server with Claude Desktop or any MCP client:
119119

@@ -132,14 +132,14 @@ npm install @utcp/code-mode
132132
```
133133

134134
**That's it!** No installation, no Node.js knowledge required. The [UTCP-MCP Bridge](https://github.com/universal-tool-calling-protocol/utcp-mcp) automatically:
135-
- Downloads and runs the latest version via `npx`
136-
- Loads your tool configurations from JSON
137-
- Provides code execution capabilities to Claude Desktop
138-
- Gives you `call_tool_chain` as an MCP tool for TypeScript execution
135+
- Downloads and runs the latest version via `npx`
136+
- Loads your tool configurations from JSON
137+
- Provides code execution capabilities to Claude Desktop
138+
- Gives you `call_tool_chain` as an MCP tool for TypeScript execution
139139

140140
**Perfect for non-developers** who want Code Mode power in Claude Desktop!
141141

142-
## 🚪 Direct TypeScript Usage
142+
## Direct TypeScript Usage
143143

144144
### 1. **MCP Server Integration**
145145
Connect to any Model Context Protocol server:
@@ -203,7 +203,7 @@ console.log('Analysis Result:', result);
203203

204204
---
205205

206-
## 🎛️ Advanced Features
206+
## Advanced Features
207207

208208
### **Multi-Protocol Tool Chains**
209209
Mix and match different tool ecosystems in a single execution:
@@ -326,7 +326,7 @@ const heavyResult = await client.callToolChain(`
326326

327327
---
328328

329-
## 🤖 AI Agent Integration
329+
## AI Agent Integration
330330

331331
Plug-and-play with any AI framework. The built-in prompt template handles all the complexity:
332332

@@ -357,7 +357,7 @@ const response = await openai.chat.completions.create({
357357

358358
---
359359

360-
## 📚 API Reference
360+
## API Reference
361361

362362
### **Core Methods**
363363

@@ -384,23 +384,23 @@ Production-ready prompt template for AI agents.
384384

385385
---
386386

387-
## 🔒 Security & Performance
387+
## Security & Performance
388388

389389
### **Secure by Design**
390-
- **Node.js VM sandboxing** – Isolated execution context
391-
- **No filesystem access** – Tools only through registered servers
392-
- **Timeout protection** – Configurable execution limits
393-
- **Zero network access** – No external dependencies or API keys exposed
390+
- **Node.js VM sandboxing** – Isolated execution context
391+
- **No filesystem access** – Tools only through registered servers
392+
- **Timeout protection** – Configurable execution limits
393+
- **Zero network access** – No external dependencies or API keys exposed
394394

395395
### **Performance Optimized**
396-
- **Minimal memory footprint** – VM contexts are lightweight
397-
- **Efficient tool caching** – TypeScript interfaces cached automatically
398-
- **Streaming console output** – Real-time log capture without buffering
399-
- **Identifier sanitization** – Handles invalid TypeScript identifiers gracefully
396+
- **Minimal memory footprint** – VM contexts are lightweight
397+
- **Efficient tool caching** – TypeScript interfaces cached automatically
398+
- **Streaming console output** – Real-time log capture without buffering
399+
- **Identifier sanitization** – Handles invalid TypeScript identifiers gracefully
400400

401401
---
402402

403-
## 🔧 Development Experience
403+
## Development Experience
404404

405405
### **IDE Integration**
406406
Generate TypeScript definitions for full IntelliSense support:
@@ -433,7 +433,7 @@ logs.forEach(log => {
433433

434434
---
435435

436-
## 🌟 Why Choose Code Mode UTCP?
436+
## Why Choose Code Mode UTCP?
437437

438438
| Traditional Tool Calling | **Code Mode UTCP** | **Improvement** |
439439
|--------------------------|-------------------|----------------|
@@ -447,23 +447,23 @@ logs.forEach(log => {
447447

448448
### **Benchmark Methodology**
449449
The [comprehensive Python study](https://github.com/imran31415/codemode_python_benchmark) tested **16 realistic scenarios** across:
450-
- 📊 **Financial workflows** (invoicing, expense tracking)
451-
- 🔧 **DevOps operations** (deployments, monitoring)
452-
- 📈 **Data processing** (analysis, reporting)
453-
- 🤝 **Business automation** (CRM, notifications)
450+
- **Financial workflows** (invoicing, expense tracking)
451+
- **DevOps operations** (deployments, monitoring)
452+
- **Data processing** (analysis, reporting)
453+
- **Business automation** (CRM, notifications)
454454

455455
**Models tested:** Claude Haiku, Gemini Flash
456456
**Pricing basis:** $0.25/1M input, $1.25/1M output tokens
457457
**Scale:** 1,000 scenarios/day = $9,536/year savings with Code Mode
458458

459-
## 📖 Learn More
459+
## Learn More
460460

461-
- 📄 **[Cloudflare Research](https://blog.cloudflare.com/code-mode/)** – Original code mode whitepaper
462-
- 🔬 **[Anthropic Study](https://www.anthropic.com/engineering/code-execution-with-mcp)** – MCP code execution benefits
463-
- 📊 **[Python Benchmark Study](https://github.com/imran31415/codemode_python_benchmark)** – Comprehensive performance analysis
464-
- 🔌 **[Ready-to-Use MCP Server](https://github.com/universal-tool-calling-protocol/utcp-mcp)** – Plug-and-play Claude Desktop integration
465-
- 🚀 **[UTCP Specification](https://github.com/universal-tool-calling-protocol/typescript-utcp)** – Official TypeScript implementation
466-
- 🐛 **[Report Issues](https://github.com/universal-tool-calling-protocol/typescript-utcp/issues)** – Bug reports and feature requests
461+
- **[Cloudflare Research](https://blog.cloudflare.com/code-mode/)** – Original code mode whitepaper
462+
- **[Anthropic Study](https://www.anthropic.com/engineering/code-execution-with-mcp)** – MCP code execution benefits
463+
- **[Python Benchmark Study](https://github.com/imran31415/codemode_python_benchmark)** – Comprehensive performance analysis
464+
- **[Ready-to-Use MCP Server](https://github.com/universal-tool-calling-protocol/utcp-mcp)** – Plug-and-play Claude Desktop integration
465+
- **[UTCP Specification](https://github.com/universal-tool-calling-protocol/typescript-utcp)** – Official TypeScript implementation
466+
- **[Report Issues](https://github.com/universal-tool-calling-protocol/typescript-utcp/issues)** – Bug reports and feature requests
467467

468468
## License
469469

0 commit comments

Comments
 (0)