Skip to content

Quick Start

Start with MCP when you are connecting an AI agent. Use the CLI when you want to test or script the same workflows from a terminal.

Install the MidLyr MCP server:

Terminal window
npx @midlyr/mcp init

Configure your API key:

Terminal window
export MIDLYR_API_KEY="ml_..."

Then connect the MCP server to your agent runtime and call tools like queryRegulatoryChunks, startComplianceScreening, and getJob.

Install the MidLyr CLI:

Terminal window
npm install -g @midlyr/cli

Submit a screening job:

Terminal window
midlyr analysis screen --text "we can't provide a provisional dispute credit until the investigation is completed"

Retrieve the result:

Terminal window
midlyr jobs get job_01HY3K4M7QR9VP2N8WYJF5GTB