MCP Integration
Platform tools via Model Context Protocol for AI agent integration with Claude, GPT, and custom agents.
MCP integration exposes the full platform API to AI agents through a built-in Model Context Protocol server, turning the CLI tool catalog into callable agent tools. Reach for it when you want Claude, GPT, or a custom agent to submit jobs, search compounds, or manage sessions programmatically rather than driving the CLI by hand. The server runs on the same backend and job history as the rest of the CLI, so agent-driven work shows up alongside your terminal and web activity. For the full command set, see the CLI overview.
Difficulty
Prerequisites
ivybloom auth login), Understanding of AI agents and tool useMCP Integration (since v0.8.53)
Platform tools via Model Context Protocol for AI agent integration with Claude, GPT, and custom agents.
Overview
The Model Context Protocol (MCP) is a standard for connecting AI agents to external tools. The ivybloom CLI includes a built-in MCP server that exposes the full platform API as tools across dozens of domains.
- Protocol version:
2024-11-05 - Transport: stdio (standard input/output)
- Tools: the full catalog across all domains with
--toolset all; the defaultcoretoolset advertises the jobs, tools, projects, results, storage, stats, suggest and orchestrate domains - Resources: URI-addressable data (listed under Resources)
- Prompt templates: 2 (
analyze_protein,drug_screening)
Starting the Server
Toolsets are core (default), research, admin and all. The IVYBLOOM_MCP_PROFILE and IVYBLOOM_MCP_DOMAINS environment variables set the same options. The catalog differs between CLI versions, so check ivybloom mcp tools on your installed binary.
The server communicates via JSON-RPC over stdio. It is designed to be launched by an AI agent or IDE, not used interactively.
Integration Examples
Claude Desktop
Add to ~/Library/Application Support/Claude/claude_desktop_config.json:
Claude Code
Register the server from a terminal:
Or add it to .mcp.json at your project root:
Python MCP Client
MCP Architecture
Tool Catalog
The main tools, organized by domain. Tool names follow the pattern domain_action (e.g., jobs_submit, compounds_search). ivybloom mcp tools --toolset all prints the complete list.
Core
| Domain | Tools | Description |
|---|---|---|
| jobs | list, submit, wait, stats, status, results, cancel, clone, search, download, deprecate, undeprecate, artifacts, logs, phase, events, self_heal | Job lifecycle management |
| tools | list, schema, validate, estimate, defaults, example, get | Tool discovery and validation |
| batch | list, submit, status, results, cancel, pause, resume | Batch job processing |
Science
| Domain | Tools | Description |
|---|---|---|
| compounds | collections_list, collections_create, collections_get, search, import, import_status, export, delete | Compound library management |
| proteinprep | run, protonate, sites, status | Protein structure preparation (PDB2PQR, P2Rank) |
| benchmarks | get, run, datasets | Tool benchmarking (benchmark_compare and benchmark_status use the singular prefix) |
| passport | list, generate, compound, compound_batch | Compound, target and safety passports |
| results | inspect, summarize, compare, query, plot | Job result analysis |
| pipelines | list, get, create, cancel, validate | Multi-step pipelines |
| discovery | browse, stats, enrich | Discovery browsing |
Conversations
| Domain | Tools | Description |
|---|---|---|
| sessions | list, create, get, append, record_tool_call, artifacts_list, artifacts_add, artifacts_consume | Session persistence |
| chats | list, get, create, delete, messages, recent, history, export | Chat management |
| checkpoints | list, create, rollback, prune | Session checkpointing |
| context | get, add_file, remove_file, add_memory, clear_memories | Chat context management |
| actions | list, get, stats, sync | Tool call action tracking |
Workspace
| Domain | Tools | Description |
|---|---|---|
| projects | list, get, create, update, delete, jobs | Project management |
| campaigns | list, get, create, update, delete | Campaign management |
| workflows | list, get, create, execute, results, templates, template_get | Workflow automation |
| templates | list, get, create, delete | Workflow templates |
Data
| Domain | Tools | Description |
|---|---|---|
| data | list, get, upload, delete, download, sync, tag | File management |
| exports | list, create, get | Data export |
| reports | list, generate, get | Report generation |
| attachments | list, upload, get, delete, url | Chat file attachments |
| sync | status, push, pull, files | Project data sync |
| resources | search, tree, stats, recent, bulk, favorite | Cross-resource operations |
| stats | overview, project | Usage statistics |
| storage | roots, browse, presign, preview, upload | Workspace storage |
AI
| Domain | Tools | Description |
|---|---|---|
| ai | complete, models | AI model completions |
| models | list, available, entitlements | Model catalog and plan entitlements |
Account
| Domain | Tools | Description |
|---|---|---|
| account | me, info, usage | Account information |
| usage | spend, summary, history, cost, cost_history, quota | Spend and quota |
| billing | subscription, plans, invoices, tokens, portal_url | Billing management |
| credits | summary, stats, history, trends, alerts_show, alerts_set, export | Credit tracking |
| profile | show, update, avatar_upload, avatar_delete, status | User profile |
| settings | show, update, newsletter_show, newsletter_update, ai_show, ai_update | App settings |
| auth | status, whoami, verify, devices, devices_revoke | Authentication |
| org | list, create, info, update, members, set_role, invitations, invite, respond_invitation, remove_member | Organizations |
| apikeys | list, create, info, update, revoke | API key management |
| devices | list, trust, untrust, remove | Device management |
| alerts | list, set, reset | Alert configuration |
| notifications | list, mark_read, update_settings | Notification management |
| flags | list, status, enable, disable, reset | Feature flags |
System
| Domain | Tools | Description |
|---|---|---|
| health | check | System health |
| docs | list, read, search, trending | Documentation access |
Error Handling
Tool failures return a structured result with isError: true and a JSON body containing:
The result is not a JSON-RPC error (those are reserved for protocol problems); instead, the tool succeeds with an error body in the result content. This allows agents to handle errors programmatically without losing context.
Resources
MCP resources provide URI-addressable access to platform data:
Agents can read resources to inspect data without executing tools.
Prompt Templates
Two built-in prompt templates guide agents through common workflows:
analyze_protein
Guided protein analysis — walks the agent through structure prediction, quality checking, and binding site detection.
drug_screening
Virtual screening workflow — guides compound library import, ADMET screening, docking, and result aggregation.
Troubleshooting
Read next
- Agent Mode — Structured JSON output for automation
- Orchestration — Natural language job submission
- Sessions — Persistent conversations with checkpointing
- Commands Reference — Full CLI command listing
Was this page helpful?