https://github.com/subspace-lab/simdoc-mcp
MCP server for scientific simulation documentation (PyBaMM, Cantera, and more)
https://github.com/subspace-lab/simdoc-mcp
cantera claude cursor mcp pybamm scientific-computing simulation
Last synced: 5 months ago
JSON representation
MCP server for scientific simulation documentation (PyBaMM, Cantera, and more)
- Host: GitHub
- URL: https://github.com/subspace-lab/simdoc-mcp
- Owner: subspace-lab
- License: mit
- Created: 2025-10-21T00:30:49.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-10-22T07:05:29.000Z (8 months ago)
- Last Synced: 2025-10-22T09:12:57.595Z (8 months ago)
- Topics: cantera, claude, cursor, mcp, pybamm, scientific-computing, simulation
- Language: Python
- Size: 11.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SimDoc MCP Server
AI-powered code search for scientific simulation documentation. Search PyBaMM, Cantera, and other simulators directly from your AI coding assistant.
## 🚀 Quick Start
### Using the Public Hosted Service (Recommended)
SimDoc provides a **free public MCP server** - no installation required.
**Endpoint:** `https://simdoc.subspace-lab.com/sse`
**Step 1: Add SimDoc to your AI assistant**
Choose your tool:
Claude Desktop
**Config file location:**
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
**Add this configuration:**
```json
{
"mcpServers": {
"simdoc": {
"url": "https://simdoc.subspace-lab.com/sse"
}
}
}
```
Claude Code
**Config file location:**
- Project: `.mcp.json` (in project root)
- User: `~/.claude/settings.local.json`
**Add this configuration:**
```json
{
"mcpServers": {
"simdoc": {
"type": "sse",
"url": "https://simdoc.subspace-lab.com/sse"
}
}
}
```
Cursor
**Config file location:** `~/.cursor/mcp.json`
**Add this configuration:**
```json
{
"mcpServers": {
"simdoc": {
"url": "https://simdoc.subspace-lab.com/sse"
}
}
}
```
Cline (VS Code)
**Setup:** Click "Configure MCP Servers" in Cline extension panel
**Add this configuration:**
```json
{
"mcpServers": {
"simdoc": {
"url": "https://simdoc.subspace-lab.com/sse",
"alwaysAllow": []
}
}
}
```
Windsurf
**Config file location:** Windsurf MCP settings
**Add this configuration:**
```json
{
"mcpServers": {
"simdoc": {
"url": "https://simdoc.subspace-lab.com/sse"
}
}
}
```
**Step 2: Restart your AI assistant**
Completely quit and reopen your AI tool.
**Step 3: Try it!**
Ask your AI assistant:
- *"How do I simulate battery aging in PyBaMM?"*
- *"Show me Cantera reactor network examples"*
- *"How can I model battery degradation over drive cycles?"*
---
## 🎯 What You Get
### Available Simulators
| Simulator | Documentation | Examples |
|-----------|---------------|----------|
| **PyBaMM** | Battery modeling | 120+ files |
| **Cantera** | Chemical kinetics & thermodynamics | 98+ files |
### MCP Tools
- **`resolve-simulator-id`** - Find simulators by name with metadata
- **`get-simulator-docs`** - Search code snippets and documentation
### Example Queries
1. **Battery Simulations**
- "How do I simulate SEI layer growth in PyBaMM?"
- "Show me battery calendar aging examples"
- "How to simulate realistic driving conditions?"
2. **Reactor Networks**
- "Set up a continuously stirred reactor in Cantera"
- "Calculate ignition delay times"
3. **Thermodynamics**
- "How to calculate specific heat of gas mixtures?"
- "Get entropy and enthalpy properties"
---
## 🏗️ How It Works
```
┌──────────────────┐
│ Your AI Client │
│ (Claude/Cursor) │
└────────┬─────────┘
│
│ HTTPS MCP Protocol
│
┌────────▼─────────┐
│ SimDoc Service │ https://simdoc.subspace-lab.com/sse
│ (Hosted) │
└──────────────────┘
```
SimDoc provides MCP tools to search scientific simulation documentation. Just add the endpoint to your AI client and start asking questions.
---
## 🐛 Troubleshooting
### MCP tools not appearing in your AI client
1. **Verify config file location and syntax**
```bash
# Claude Desktop (macOS)
cat ~/Library/Application\ Support/Claude/claude_desktop_config.json
# Validate JSON syntax
python3 -m json.tool < config.json
```
2. **Check the URL is correct**
- Should be: `https://simdoc.subspace-lab.com/sse`
- Common mistake: Using `http://` instead of `https://`
3. **Restart your AI client completely**
```bash
# Claude Desktop (macOS)
killall Claude && open -a Claude
```
4. **Test the endpoint directly**
```bash
curl https://simdoc.subspace-lab.com/sse
# Expected: "event: endpoint" response
```
5. **Check your AI client's MCP logs**
- Claude Desktop (macOS): `~/Library/Logs/Claude/mcp*.log`
- Look for connection errors or timeout messages
---
## 📖 More Information
- **Example Queries**: [MCP Showcase](../md-files/MCP_SHOWCASE.md) - Real usage examples
- **Main Repository**: [SimDoc README](../README.md) - Full project overview
- **Report Issues**: [GitHub Issues](https://github.com/your-org/simdoc/issues)
---
## 🤝 Contributing
Contributions welcome! See the main repository for guidelines.
---
## 📝 License
MIT License - see LICENSE file for details.
---
**Built with** ❤️ **for the scientific computing community**