MCP Server

Reference for the active MicroStax MCP server surface: tools, resources, prompts, and how agents use them.

MicroStax exposes a first-class MCP server for agent workflows. The current implementation registers:

  • 40 tools
  • 5 resources
  • 3 built-in prompts

This page documents the active server surface created by createMcpServer().

Connection model

The MCP server is a task-oriented interface over the same control plane used by the CLI and dashboard.

Typical configuration:

  • API URL from MCP server config
  • bearer token for authenticated actions
  • optional organization scope for org-specific tasks

Tool Catalog

Environment tools

ToolInputsPurpose
env_liststatus?List environments, optionally filtered by status.
env_getidFetch environment details.
env_createblueprint, name?Create a new environment from Blueprint content.
env_deleteidDelete an environment.
env_stopidStop an environment.
env_resumeidResume an environment.
env_statusidFetch live service status.
env_updateid, name?, autoShutdownEnabled?, autoShutdownDelayMinutes?Update mutable environment settings.
env_scaleid, service, replicasScale a service.
env_replayid, snapshotId?Replay an environment execution graph.
env_get_diffsidFetch behavioral diffs for an environment.

Blueprint tools

ToolInputsPurpose
blueprint_validateblueprintValidate Blueprint content before deployment.
blueprint_discoverpath?Discover a Blueprint from source code.

Logs, topology, metrics, and drift tools

ToolInputsPurpose
env_logsid, service?, lines?Fetch recent logs.
env_topologyidReturn topology graph data.
env_metricsidReturn resource metrics.
env_deviationsidReturn configuration drift data.
env_cost_analysisidReturn sparse cost analysis and savings.

Diagnosis and remediation tools

ToolInputsPurpose
env_diagnoseidRun AI diagnosis.
env_diagnose_applyid, suggestionIdApply a diagnosis suggestion.

Snapshot and data tools

ToolInputsPurpose
snapshot_createid, service?Create a snapshot.
snapshot_listidList snapshots for an environment.
env_seedid, service, script, typeRun an inline seed script against an environment.
seed_searchquerySearch the seed registry.
seed_runname, envId, version?Run a published seed.
seed_publishname, version, content, serviceTypePublish a seed artifact.

Baseline and overlay tools

ToolInputsPurpose
baseline_promoteid, force?Promote an environment to baseline.
overlay_createbaselineId, name, blueprintCreate an overlay from a baseline.
overlay_deleteoverlayIdDelete an overlay.

Sharing, template, and stub tools

ToolInputsPurpose
env_shareid, expiresInHours?Create a shareable link.
template_listnoneList templates.
template_getidFetch one template.
stub_generatespecGenerate AI service stubs from an API spec.

Health, billing, and organization tools

ToolInputsPurpose
health_checknoneQuick API health check.
health_detailsnoneDetailed system health response.
billing_getnoneBilling and plan summary.
org_getid?Get organization details.
org_analyticsnoneOrganization analytics summary.
org_compliance_reportorgIdCompliance report.
governance_logs_getnoneGovernance audit log summary.

Resources

The active server registers the following MCP resources:

ResourceURIPurpose
environment_listmicrostax://environmentsCurrent environment list as JSON.
environment_detailmicrostax://environments/{id}One environment record as JSON.
environment_logsmicrostax://environments/{id}/logsEnvironment logs as plain text.
blueprint_schemamicrostax://schema/blueprintBlueprint schema resource.
template_listmicrostax://templatesTemplate inventory as JSON.

Built-In Prompts

The active server exposes these built-in prompts:

PromptInputsIntended flow
create-environmentdescriptionGenerate Blueprint, validate, create environment.
diagnose-failuresenvironment_idFetch details, inspect logs/topology, run diagnosis.
blueprint-reviewblueprintReview Blueprint content before deployment.

Typical agent workflow

Create and verify an environment

  1. read microstax://schema/blueprint
  2. generate Blueprint text
  3. call blueprint_validate
  4. call env_create
  5. poll with env_get or env_status

Diagnose a broken environment

  1. call env_get
  2. call env_status
  3. call env_logs
  4. call env_topology
  5. call env_diagnose
  6. optionally call env_diagnose_apply

Data and validation workflows

  1. call snapshot_create
  2. call seed_search or env_seed
  3. call env_get_diffs
  4. call env_cost_analysis

Practical guidance

  • use MCP when the caller wants task semantics rather than low-level REST orchestration
  • use resources for read-mostly context such as schema, template inventory, and environment state
  • use prompts to standardize agent behavior for environment creation and diagnosis
  • prefer the REST API or CLI when a workflow depends on exact transport-level control or large-scale scripting
MCP Server | MicroStax Documentation