ngspice-mcp
If you are the rightful owner of ngspice-mcp and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to henry@mcphub.com.
ngspice-mcp is a Model Context Protocol server that provides access to ngspice circuit simulation functionality through a standardized protocol interface.
ngspice-mcp
A Model Context Protocol (MCP) server that provides access to ngspice circuit simulation functionality through a standardized protocol interface. This server enables AI language models to interact with ngspice in a controlled and structured way.
Features
- Integration with ngspice's shared library interface
- Standardized MCP protocol implementation
- Synchronous operation with structured data access
- Comprehensive output capture and redirection
- Vector data handling with multiple representation formats
- Support for both server and library usage modes
- Built-in test suite
Requirements
- D compiler (DMD/LDC)
- ngspice shared library
- MCP server library (d-mcp-server)
- D build system (dub)
Installation
- Ensure system requirements are installed
- Clone the repository
- Build using dub:
dub build --config=server
Usage
The server can be started with:
./ngspice-mcp [options]
Command Line Options
--working-dir,-d: Set the working directory for circuit files (default: current directory)
Available Tools
Circuit Loading
loadCircuit: Load circuit netlists directlyloadNetlistFromFile: Load netlists from files
Example netlist:
RC Circuit
R1 in out 1k
C1 out 0 1u
.end
Simulation
runSimulation: Execute simulation commands
Common commands:
op: DC operating pointdc source start stop stepac dec points fstart fendtran step tstop
Data Access
getPlotNames: List available simulation plotsgetVectorNames: List vectors in a specific plotgetVectorData: Retrieve vector data with options for:- Magnitude-phase representation
- Rectangular (real-imaginary) representation
- Both representations
- Optional interval selection
Resources
stdout://: Standard output stream from ngspicestderr://: Error output stream from ngspiceusage://: Comprehensive usage guide
Development
Project Structure
ngspice-mcp/
├── source/
│ ├── app.d # Main application
│ ├── bindings/ # ngspice C API bindings
│ ├── database/ # SQLite database handling
│ ├── parser/ # Netlist parsing
│ └── server/ # MCP server implementation
├── resources/ # Resource files
└── bin/ # Build outputs
Build Configurations
- Server Mode
dub build --config=server
- Library Mode
dub build --config=library
- Unit Tests
dub test --config=unittest
Testing
Run the test suite:
dub test
Tests cover:
- ngspice bindings
- Server functionality
- Tool validation
- Resource handling
- Error cases
Technical Details
Architecture
The server implements several key components:
-
NgspiceServer: Core server implementation
- Tool registration and handling
- Resource management
- Output stream capture
- Vector data processing
-
Output System
- Stdout/stderr capture
- Stream buffering
- Resource notification
-
Vector Processing
- Complex number handling
- Scientific notation formatting
- Interval selection
- Multiple representation formats
Database System
- Model parameter storage
- Efficient indexing and querying
- Transaction support
- Concurrent access handling
License
MIT License - see for details.
Copyright © 2024, Garret Noble
Contributing
Contributions are welcome! Please ensure:
- Code follows project style and standards
- Tests are included for new functionality
- Documentation is updated as needed
- Commit messages are clear and descriptive
