pyResToolbox MCP Server

# Release Notes Template for GitHub ## pyResToolbox MCP Server v1.0.0 🎉 **First Production Release** - Model Context Protocol server for AI-powered reservoir engineering calculations ### 🌟 Highlights - **47 Reservoir Engineering Tools** - 100% tested and working - **Zero Failures** - All tools passing validation - **Production Ready** - Docker, UV, comprehensive docs - **GPL-3.0 Licensed** - Matches upstream pyResToolbox - **Claude Desktop Ready** - Easy AI agent integration ### 📦 What's Included #### Oil PVT Tools (17) Bubble point, solution GOR, FVF, viscosity, density, compressibility, black oil tables, and more #### Gas PVT Tools (11) Z-factor, critical properties, FVF, viscosity, density, compressibility, pseudopressure, and more #### Inflow Performance (4) Radial/linear flow for both oil and gas wells #### Simulation Tools (3) Relative permeability tables (Corey/LET), aquifer influence functions, Rachford-Rice flash #### Additional Tools (9) Brine properties, layer heterogeneity, component library ### 🚀 Quick Start ```bash # Install UV curl -LsSf https://astral.sh/uv/install.sh | sh # Clone and setup git clone https://github.com/YOUR_ORG/pyrestoolbox-mcp.git cd pyrestoolbox-mcp make uv-install # Verify (all 47 tools should pass) uv run python test_tools.py # Run server make uv-server ``` ### 📚 Documentation - [README.md](README.md) - Complete documentation - [QUICKSTART.md](QUICKSTART.md) - Getting started guide - [CONTRIBUTING.md](CONTRIBUTING.md) - How to contribute - [TEST_RESULTS.md](TEST_RESULTS.md) - Test coverage report - [PRODUCTION_READY.md](PRODUCTION_READY.md) - Deployment guide ### 🐛 Bug Fixes - Standalone implementation of `gas_grad2sg` (fixed upstream bug) - Corrected 25+ parameter name mismatches - Inflow tools now auto-calculate PVT properties - Proper array/scalar handling across all tools - Type conversion for mpmath, numpy, pandas objects ### 🏗️ Built With - [pyResToolbox](https://github.com/mwburgoyne/pyResToolbox) - Core calculations - [FastMCP](https://github.com/jlowin/fastmcp) - MCP framework - [Pydantic](https://pydantic.dev) - Validation - [UV](https://github.com/astral-sh/uv) - Fast package management ### 📄 License GPL-3.0 - Same as [pyResToolbox](https://github.com/mwburgoyne/pyResToolbox) ### 🙏 Acknowledgments Built on the excellent [pyResToolbox](https://github.com/mwburgoyne/pyResToolbox) library by Mark Burgoyne. --- **Full Changelog**: [CHANGELOG.md](CHANGELOG.md) **Contributors**: See [CONTRIBUTING.md](CONTRIBUTING.md)