Skip to content

Commit 158d86f

Browse files
committed
Update README.md
1 parent 2ebfcbf commit 158d86f

1 file changed

Lines changed: 44 additions & 23 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 44 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
66
[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
77

8-
A production-ready Model Context Protocol (MCP) server that provides advanced statistical analysis capabilities through R. RMCP enables AI assistants and applications to perform sophisticated statistical modeling, econometric analysis, and data science tasks seamlessly.
8+
**Version 0.2.0** - A production-ready Model Context Protocol (MCP) server that provides advanced statistical analysis capabilities through R. RMCP enables AI assistants and applications to perform sophisticated statistical modeling, econometric analysis, and data science tasks seamlessly.
99

1010
## πŸš€ Quick Start
1111

@@ -22,16 +22,17 @@ That's it! RMCP is now ready to handle statistical analysis requests via the Mod
2222

2323
## ✨ Features
2424

25-
### Statistical Analysis
26-
- **Linear Regression**: OLS with robust standard errors, diagnostic tests
27-
- **Logistic Regression**: Binary classification with odds ratios and accuracy metrics
28-
- **Correlation Analysis**: Pearson, Spearman, and Kendall correlations
29-
- **Advanced Modeling**: Full R statistical ecosystem access
25+
### Statistical Analysis βœ… Available Now
26+
- **Linear Regression** (`linear_model`): OLS with robust standard errors, RΒ², p-values
27+
- **Logistic Regression** (`logistic_regression`): Binary classification with odds ratios and accuracy
28+
- **Correlation Analysis** (`correlation_analysis`): Pearson, Spearman, and Kendall correlations
3029

31-
### Data Operations
32-
- **File Analysis**: CSV, Excel, and data file processing
33-
- **Data Transformation**: Cleaning, filtering, and reshaping
34-
- **Descriptive Statistics**: Comprehensive summary statistics
30+
### Coming Soon 🚧
31+
- **Time Series Analysis**: ARIMA, VAR models, forecasting
32+
- **Panel Data Models**: Fixed effects, random effects regression
33+
- **Data Transformation**: Lag/lead variables, differencing, winsorization
34+
- **Advanced Diagnostics**: Heteroskedasticity, autocorrelation tests
35+
- **File Operations**: CSV analysis, data import/export
3536

3637
### Production Ready
3738
- **MCP Protocol**: Full JSON-RPC 2.0 compliance
@@ -132,23 +133,41 @@ Add to your Claude Desktop MCP configuration:
132133
rmcp start
133134

134135
# Check version
135-
rmcp version
136+
rmcp --version
136137

137-
# Run with specific configuration
138-
rmcp start --transport stdio --port 3000
138+
# Advanced server configuration
139+
rmcp serve --log-level DEBUG --read-only
140+
141+
# List available tools and capabilities
142+
rmcp list-capabilities
139143
```
140144

141145
### Programmatic Usage
142146

143147
```python
144-
import asyncio
145-
from rmcp import MCPServer
146-
147-
async def main():
148-
server = MCPServer()
149-
await server.start()
148+
# RMCP is primarily designed as a CLI MCP server
149+
# For programmatic R analysis, use the MCP protocol:
150+
151+
import json
152+
import subprocess
153+
154+
# Send analysis request to RMCP server
155+
request = {
156+
"tool": "linear_model",
157+
"args": {
158+
"formula": "y ~ x",
159+
"data": {"x": [1, 2, 3], "y": [2, 4, 6]}
160+
}
161+
}
150162

151-
asyncio.run(main())
163+
# Start server and send request via stdin
164+
proc = subprocess.Popen(['rmcp', 'start'],
165+
stdin=subprocess.PIPE,
166+
stdout=subprocess.PIPE,
167+
stderr=subprocess.PIPE,
168+
text=True)
169+
result, _ = proc.communicate(json.dumps(request))
170+
print(result)
152171
```
153172

154173
### API Examples
@@ -209,10 +228,12 @@ RMCP includes comprehensive testing with realistic scenarios:
209228
# Run all user scenarios (should show 100% pass rate)
210229
python tests/realistic_scenarios.py
211230

212-
# Run development tests
213-
./src/rmcp/scripts/test.sh
231+
# Run development test script
232+
bash src/rmcp/scripts/test.sh
214233
```
215234

235+
**Current Test Coverage**: 100% success rate across 4 realistic user scenarios covering business analysis, economics research, data science, and academic research use cases.
236+
216237
## πŸ—οΈ Architecture
217238

218239
RMCP is built with production best practices:
@@ -257,7 +278,7 @@ MIT License - see [LICENSE](LICENSE) file for details.
257278

258279
## πŸ™‹ Support
259280

260-
- πŸ“– **Documentation**: Check the examples in `/examples`
281+
- πŸ“– **Documentation**: See [Quick Start Guide](examples/quick_start_guide.md) for working examples
261282
- πŸ› **Issues**: [GitHub Issues](https://github.com/gojiplus/rmcp/issues)
262283
- πŸ’¬ **Discussions**: [GitHub Discussions](https://github.com/gojiplus/rmcp/discussions)
263284

0 commit comments

Comments
Β (0)