InstrMCP

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
      • Jupyter MCP Server
      • STDIO Proxy
      • JupyterLab Extension
      • QCodes Integration
    • Tool Categories
      • Notebook Tools (Safe)
      • QCodes Tools (Safe)
      • Unsafe Tools
      • Database Tools (Optional)
      • MeasureIt Tools (Optional)
    • Resources
    • Communication Flow
    • Safety Architecture
    • Extension Points
    • Performance Considerations
  • MCP Tools Reference
    • Notebook Tools
      • list_variables
      • get_variable_info
      • get_editing_cell
      • get_editing_cell_output
      • get_notebook_cells
      • move_cursor
      • server_status
    • QCodes Instrument Tools
      • instrument_info
      • get_parameter_values
    • Unsafe Tools
      • execute_editing_cell
      • add_new_cell
      • delete_editing_cell
      • apply_patch
      • delete_cells
    • Database Tools (Optional)
      • list_experiments
      • get_dataset_info
      • get_database_stats
    • MeasureIt Tools (Optional)
      • get_measureit_status
      • wait_for_sweep
      • wait_for_all_sweeps
    • Tool Call Examples
    • Best Practices
  • Jupyter Integration
    • Extension Architecture
    • IPython Extension
      • Magic Commands
      • Auto-Loading
    • JupyterLab Extension
      • Installation
      • Communication Protocol
    • Active Cell Bridging
      • How It Works
      • Supported Operations
      • Example: Custom Tool Using Comm
    • Notebook Variable Inspection
      • Variable Types
      • Type Filtering
      • Variable Information
    • Cell Output Capture
      • Output Types
      • Example Usage
      • Error Handling
    • Performance Considerations
      • Caching
      • Rate Limiting
      • Best Practices
    • Troubleshooting
      • Extension Not Loading
      • Comm Connection Issues
      • Magic Commands Not Working
      • Tools Returning Stale Data
    • Advanced Usage
      • Custom Comm Handlers
      • Extension Development
  • Database Integration
    • Overview
    • Database Tools
      • list_experiments
      • get_dataset_info
      • get_database_stats
    • Database Resources
    • Database Path Resolution
      • Resolution Priority
      • Path Format Examples
      • Nested Database Search (scan_nested)
    • Default Database Location
    • Database Structure
      • Key Tables
    • Example Queries
      • Via Claude Interface
    • Code Generation
      • Pattern Recognition
      • Template Extraction
    • Safety and Limitations
      • Read-Only Access
      • Performance Considerations
      • Privacy
    • Configuration
      • Database Path
      • MeasureIt Integration
      • Resource Configuration
    • Troubleshooting
      • “Database not found”
      • “Databases/Databases/ nested directories created”
      • “No datasets returned”
      • “Database is locked”
      • Performance Issues
    • Advanced Usage
      • Custom Database Queries
      • Database Migrations
    • Best Practices
  • MeasureIt Integration
    • Overview
    • MeasureIt Tools
      • get_measureit_status
    • MeasureIt Resources
      • measureit_sweep0d_template
      • measureit_sweep1d_template
      • measureit_sweep2d_template
      • measureit_simulsweep_template
      • measureit_sweepqueue_template
      • measureit_common_patterns
      • measureit_code_examples
    • Code Generation
      • Pattern-Based Generation
      • Context-Aware Suggestions
    • Sweep Configuration
      • Common Parameters
      • Data Management
      • Real-time Plotting
    • Status Monitoring
      • Check Running Sweeps
    • Best Practices
      • Delays and Settling
      • Data Organization
      • Error Handling
      • Safety Limits
    • Integration with Database
    • Customization
      • Custom Sweep Templates
    • Troubleshooting
      • MeasureIt Not Found
      • Templates Not Loading
      • Status Tool Not Working
    • Advanced Usage
      • Nested Sweeps
      • Conditional Measurements
      • Parallel Measurements
    • Further Reading

API Reference

  • API Reference
    • Servers
      • Jupyter QCodes Server
        • JupyterMCPServer
      • QCodes Tools
        • QCodesReadOnlyTools
      • Unsafe Tools
      • Active Cell Bridge
        • register_comm_target()
        • request_frontend_snapshot()
        • get_active_cell()
        • get_bridge_status()
        • update_active_cell()
        • execute_active_cell()
        • add_new_cell()
        • delete_editing_cell()
        • apply_patch()
        • delete_cells_by_number()
        • get_cached_cell_output()
        • invalidate_cell_output_cache()
        • get_cell_outputs()
        • move_cursor()
        • get_active_cell_output()
        • get_notebook_structure()
        • get_cells_by_index()
        • delete_cells_by_index()
      • Tool Registrars
        • QCodes Tool Registrar
        • Notebook Tool Registrar
        • Database Tool Registrar
        • MeasureIt Tool Registrar
        • Resource Registrar
      • Cache
        • ReadCache
        • RateLimiter
        • ParameterPoller
      • Jupyter Extension
        • MCPMagics
        • load_ipython_extension()
        • unload_ipython_extension()
        • get_server()
        • get_server_status()
        • broadcast_server_status()
      • Standalone QCodes Server
      • QCodes Station Initialization
    • Utils
      • STDIO Proxy
        • check_http_mcp_server()
        • create_stdio_proxy_server()
        • StdioMCPClient
        • Key Functions
    • Extensions
      • Database Extension
        • Database Resources
        • Query Tools
      • MeasureIt Extension
        • MeasureIt Templates
      • JupyterLab Extension
        • Key Components
        • Building the Extension
    • CLI
      • Main CLI Module
        • main()
      • Commands
        • version
        • config
      • Setup Utilities
        • setup_jupyter_extension()
        • setup_jupyter_config()
        • setup_all()
        • Key Functions
      • Server CLI Modules
        • Jupyter QCodes CLI
      • Environment Variables
        • INSTRMCP_PATH
        • MEASUREIT_HOME
        • QCODES_DB_LOCATION
      • Exit Codes
      • Example Usage
        • Typical Workflow
        • metadata tokens
        • Development Workflow
    • Module Overview
      • Servers
      • Utils
      • Extensions
      • CLI
    • Quick Links
      • Commonly Used Classes and Functions

Development

  • Changelog
    • Version 1.0.0 (2025-01-XX)
      • Added
      • Changed
      • Fixed
      • Documentation
    • Version 0.3.0 (2024-12-XX)
      • Added
      • Changed
    • Version 0.2.0 (2024-11-XX)
      • Added
      • Changed
    • Version 0.1.0 (2024-10-XX)
      • Added
      • Features
      • Known Issues
    • Future Plans
      • Version 1.1.0 (Planned)
      • Version 1.2.0 (Planned)
      • Long-term Roadmap
    • Contributing
  • Contributing
    • Getting Started
    • Development Workflow
      • Code Changes
      • Testing
      • Code Quality
      • Documentation
      • JupyterLab Extension
    • Guidelines
      • Code Style
      • Docstring Format
      • Commit Messages
    • Pull Request Process
    • Areas for Contribution
      • High Priority
      • Medium Priority
      • Low Priority (but welcome!)
    • Specific Contribution Ideas
      • New MCP Tools
      • New Resources
      • JupyterLab Extension Features
      • Database Queries
    • Testing Guidelines
      • Test Structure
      • Mock Instruments
      • Async Testing
    • Documentation Contributions
      • Documentation Types
      • Writing Style
      • Adding Examples
    • Code of Conduct
      • Be Respectful
      • Be Professional
    • Community
    • Getting Help
    • Questions?
  • License
    • MIT License
    • What This Means
    • Dependencies
      • Core Dependencies
      • Development Dependencies
    • Contributing
    • Questions
InstrMCP
  • Python Module Index

Python Module Index

i
 
i
- instrmcp
    instrmcp.cli
    instrmcp.servers.jupyter_qcodes.active_cell_bridge
    instrmcp.servers.jupyter_qcodes.cache
    instrmcp.servers.jupyter_qcodes.core.notebook_tools
    instrmcp.servers.jupyter_qcodes.core.qcodes_tools
    instrmcp.servers.jupyter_qcodes.core.resources
    instrmcp.servers.jupyter_qcodes.jupyter_mcp_extension
    instrmcp.servers.jupyter_qcodes.mcp_server
    instrmcp.servers.jupyter_qcodes.tools
    instrmcp.setup_utils
    instrmcp.utils.stdio_proxy

© Copyright 2025, Jiaqi Cai.

Built with Sphinx using a theme provided by Read the Docs.