API Reference

This section contains the API documentation for InstrMCP modules.

• Servers
  • Jupyter QCodes Server
  • QCodes Tools
  • Unsafe Tools
  • Active Cell Bridge
  • Tool Registrars
  • Cache
  • Jupyter Extension
  • Standalone QCodes Server
  • QCodes Station Initialization
• Utils
  • STDIO Proxy
• Extensions
  • Database Extension
  • MeasureIt Extension
  • JupyterLab Extension
• CLI
  • Main CLI Module
  • Commands
  • Setup Utilities
  • Server CLI Modules
  • Environment Variables
  • Exit Codes
  • Example Usage

Module Overview

InstrMCP is organized into several main modules:

Servers

The server modules implement MCP servers:

• instrmcp.servers.jupyter_qcodes: Main Jupyter+QCodes MCP server

See Servers for detailed API documentation.

Utils

The utils module provides internal utilities and helper functions:

• instrmcp.utils.stdio_proxy: STDIO↔HTTP proxy for MCP clients

See Utils for detailed API documentation.

Extensions

Extensions add optional functionality:

• instrmcp.extensions.database: Database integration

• instrmcp.extensions.measureit: MeasureIt template library

• instrmcp.extensions.jupyterlab: JupyterLab extension

See Extensions for detailed API documentation.

CLI

Command-line interface for server management:

• instrmcp.cli: Main CLI entry point

See CLI for detailed API documentation.

Quick Links

Commonly Used Classes and Functions

Server Classes:

• instrmcp.servers.jupyter_qcodes.mcp_server.JupyterQCodesMCPServer

Tool Functions:

• instrmcp.servers.jupyter_qcodes.tools.QCodesReadOnlyTools.get_parameter_values()

• instrmcp.servers.jupyter_qcodes.tools.QCodesReadOnlyTools.list_variables()

Registrars:

• instrmcp.servers.jupyter_qcodes.core.QCodesToolRegistrar

• instrmcp.servers.jupyter_qcodes.core.NotebookToolRegistrar

Extension Functions:

• instrmcp.extensions.database.query_tools.list_experiments()

• instrmcp.extensions.measureit.measureit_templates.get_sweep1d_template()