InstrMCP Documentation

Welcome to InstrMCP

InstrMCP is an MCP server suite for quantum device physics laboratory instrumentation control, enabling Large Language Models to interact directly with physics instruments and measurement systems through QCodes and JupyterLab.

Features

• Full QCodes Integration: Built-in support for all QCodes instrument drivers

• Database Integration: Read-only access to QCodes databases with intelligent code generation

• MeasureIt Templates: Comprehensive measurement pattern library and code generation

• JupyterLab Native: Seamless integration with JupyterLab

• Safe Mode: Read-only mode with optional unsafe execution

• CLI: Easy server management with instrmcp command

• MCP: Standard Model Context Protocol for LLM integration

• Tested with Claude Desktop, Claude Code, and Codex CLI

Quick Links

• GitHub Repository: https://github.com/caidish/instrMCP

• PyPI Package: Coming soon

• Issue Tracker: https://github.com/caidish/instrMCP/issues

Documentation Contents

Getting Started

• Installation
  • Requirements
  • Installation from Source
  • Optional Dependencies
  • JupyterLab Extension
  • Verification
  • Troubleshooting
  • Next Steps
• Quick Start
  • Starting the MCP Server in JupyterLab
  • Server Management
  • Safe vs Unsafe Mode
  • Optional Features
  • Connecting Claude Desktop/Code
  • Using QCodes Instruments
  • Example Workflow
  • Next Steps

User Guide

• Architecture
  • System Overview
  • Core Components
  • Tool Categories
  • Resources
  • Communication Flow
  • Safety Architecture
  • Extension Points
  • Performance Considerations
• MCP Tools Reference
  • Notebook Tools
  • QCodes Instrument Tools
  • Unsafe Tools
  • Database Tools (Optional)
  • MeasureIt Tools (Optional)
  • Tool Call Examples
  • Best Practices
• Jupyter Integration
  • Extension Architecture
  • IPython Extension
  • JupyterLab Extension
  • Active Cell Bridging
  • Notebook Variable Inspection
  • Cell Output Capture
  • Performance Considerations
  • Troubleshooting
  • Advanced Usage
• Database Integration
  • Overview
  • Database Tools
  • Database Resources
  • Database Path Resolution
  • Default Database Location
  • Database Structure
  • Example Queries
  • Code Generation
  • Safety and Limitations
  • Configuration
  • Troubleshooting
  • Advanced Usage
  • Best Practices
• MeasureIt Integration
  • Overview
  • MeasureIt Tools
  • MeasureIt Resources
  • Code Generation
  • Sweep Configuration
  • Status Monitoring
  • Best Practices
  • Integration with Database
  • Customization
  • Troubleshooting
  • Advanced Usage
  • Further Reading

API Reference

• API Reference
  • Servers
  • Utils
  • Extensions
  • CLI
  • Module Overview
  • Quick Links

Development

• Changelog
• Contributing
• License

Indices and tables

• Index

• Module Index

• Search Page