MCP Server | Agile Data Engine

Public Preview

The ADE MCP Server exposes ADE metadata and product documentation to AI coding assistants via the Model Context Protocol (MCP).

Connecting

Authentication uses External API keys, which can be created from Admin UI. MCP Server URL is: https://external.services.saas.agiledataengine.com/mcp

During Private Preview, network access is IP-restricted. Contact ADE support to request MCP Server activation.

VSCode with GitHub Copilot

The following example shows a config with design, dev and prod environments. Place it in .vscode/mcp.json in your project:

mcp.json

JSON

{
  "servers": {
    "ade-mcp-design": {
      "url": "https://external.services.saas.agiledataengine.com/mcp/<tenant>/<installation>/design",
      "type": "http",
      "headers": {
        "X-API-KEY-ID": "${input:ade-design-key-id}",
        "X-API-KEY-SECRET": "${input:ade-design-key-secret}"
      }
    },
    "ade-mcp-dev": {
      "url": "https://external.services.saas.agiledataengine.com/mcp/<tenant>/<installation>/dev",
      "type": "http",
      "headers": {
        "X-API-KEY-ID": "${input:ade-dev-key-id}",
        "X-API-KEY-SECRET": "${input:ade-dev-key-secret}"
      }
    },
    "ade-mcp-prod": {
      "url": "https://external.services.saas.agiledataengine.com/mcp/<tenant>/<installation>/prod",
      "type": "http",
      "headers": {
        "X-API-KEY-ID": "${input:ade-prod-key-id}",
        "X-API-KEY-SECRET": "${input:ade-prod-key-secret}"
      }
    }
  },
  "inputs": [
    {
      "id": "ade-design-key-id",
      "type": "promptString",
      "description": "DESIGN: ADE API Key ID"
    },
    {
      "id": "ade-design-key-secret",
      "type": "promptString",
      "description": "DESIGN: ADE API Key Secret",
      "password": true
    },
    {
      "id": "ade-dev-key-id",
      "type": "promptString",
      "description": "DEV: ADE API Key ID"
    },
    {
      "id": "ade-dev-key-secret",
      "type": "promptString",
      "description": "DEV: ADE API Key Secret",
      "password": true
    },
    {
      "id": "ade-prod-key-id",
      "type": "promptString",
      "description": "PROD: ADE API Key ID"
    },
    {
      "id": "ade-prod-key-secret",
      "type": "promptString",
      "description": "PROD: ADE API Key Secret",
      "password": true
    }
  ]
}

Be sure to replace tenant and installation in the above configuration.

In VSCode, you need to input in a prompt the API key ID and Secret.

Claude Code

Add the following to .mcp.json in your project:

.mcp.json

JSON

{
  "mcpServers": {
    "ade-mcp-design": {
      "type": "http",
      "url": "https://external.services.saas.agiledataengine.com/mcp/<tenant>/<installation>/design",
      "headers": {
        "X-API-KEY-ID": "${ADE_DESIGN_API_KEY_ID}",
        "X-API-KEY-SECRET": "${ADE_DESIGN_API_KEY_SECRET}"
      }
    },
    "ade-mcp-dev": {
      "type": "http",
      "url": "https://external.services.saas.agiledataengine.com/mcp/<tenant>/<installation>/dev",
      "headers": {
        "X-API-KEY-ID": "${ADE_DEV_API_KEY_ID}",
        "X-API-KEY-SECRET": "${ADE_DEV_API_KEY_SECRET}"
      }
    },
    "ade-mcp-prod": {
      "type": "http",
      "url": "https://external.services.saas.agiledataengine.com/mcp/<tenant>/<installation>/prod",
      "headers": {
        "X-API-KEY-ID": "${ADE_PROD_API_KEY_ID}",
        "X-API-KEY-SECRET": "${ADE_PROD_API_KEY_SECRET}"
      }
    }
  }
}

Be sure to replace tenant and installation in the above configuration.

In Claude Code you need to setup the environment variables for API-keys.

Tools

The MCP server is partly based on the GET endpoints from the External API, but it has additional tools based on ADE product documentation or Insights data and AI indexes.

The set of available tools depends on the environment type. Design environments expose design-time tools, runtime environments expose runtime tools. The server only lists tools relevant to the connected environment.

Category	Tool	Description	Design	Runtime
Code	`ade_code_getCodePreviewV1`	Preview generated code (LOAD, ENTITY, TRANSFORM, LOAD_PROCEDURES).	✅	✅
Code	`ade_code_getLoadV1`	Generate a DvLoad without deploying it.	✅	✅
Deployment	`ade_deployment_findCommits`	Query a list of commits with filters.	✅
Deployment	`ade_deployment_provideCommitInfo`	Get info about a specific commit.	✅
Deployment	`ade_deployment_providePackageContent`	Get the package JSON content of a commit.	✅
Deployment	`ade_deployment_findDeployments`	Query a list of deployments with filters.	✅
Deployment	`ade_deployment_queryDeployment`	Get info about a specific deployment.	✅
Deployment	`ade_deployment_queryDeploymentPhases`	Get phase information for a deployment.	✅
Deployment	`ade_deployment_findPromotions`	Query promotions with filters.	✅
Deployment	`ade_deployment_queryPromotion`	Get info about a single promotion.	✅
Deployment	`ade_deployment_queryPackages`	Query a list of packages.	✅
Deployment	`ade_deployment_queryEnvironmentList`	Query a list of environments.	✅
Deployment	`ade_deployment_queryEnvironment`	Get info about a specific environment.	✅
Deployment	`ade_deployment_queryTargetInstances`	Query target instances of an environment.	✅
Deployment	`ade_deployment_queryTargetInstance`	Get info about a specific target instance.	✅
Metadata	`ade_metadata_search`	BM25 keyword search across metadata objects.	✅	✅
Metadata	`ade_metadata_fetch`	Fetch metadata via generated SQL select.	✅	✅
Metadata	`ade_metadata_findNodes`	Cross-type flat search across all node types.	✅	✅
Metadata	`ade_metadata_findEr`	Entity-Relationship graph.	✅	✅
Metadata	`ade_metadata_findLineage`	Data lineage graph (upstream/downstream).	✅	✅
Metadata	`ade_metadata_findPackages`	Package dependency graph.	✅	✅
Metadata	`ade_metadata_findWorkflows`	Workflow graph (scheduling → load → entity).	✅	✅
Metadata	`ade_metadata_queryMetadataGetV1`	Query metadata database via GraphQL.	✅	✅
Metadata	`ade_metadata_exportEntitiesCsv`	Export entities in CSV format.	✅	✅
Metadata	`ade_metadata_exportEntitiesYaml`	Export entities in YAML format.	✅	✅
Metadata	`ade_metadata_exportPackagesJson`	Export a single package in JSON format.	✅	✅
Metadata	`ade_metadata_getEntitiesSchemaYaml`	Get entity schema in YAML format.	✅	✅
Documentation	`ade_doc_search`	Search ADE documentation using BM25.	✅	✅
Documentation	`ade_doc_fetch`	Fetch full ADE documentation content by docid.	✅	✅
General	`ade_general_me`	Get info about the caller (API key name).	✅	✅
General	`ade_general_infoenvironments`	Get info about environments (unversioned).	✅	✅
Diagnostics	`ade_ping_pong_pingpong`	Test request/response exchange with target environment.	✅	✅
Resources	`server_instructions`	Return server instructions (call once per session).	✅	✅
Resources	`list_resources`	List available resources and resource templates.	✅	✅
Resources	`read_resource`	Read a resource by its URI.	✅	✅
Connection	`ade_connectiontest_test`	Run connection test for a given target instance.		✅
Dagger	`ade_dagger_v2_findDagRuns`	Find dag runs with filters (use `~` for all dags).		✅
Dagger	`ade_dagger_v1_getDagRun`	Query a single dag run by `execDate`.		✅
Dagger	`ade_dagger_v2_getDagRun`	Get a single dag run by `dagRunId`.		✅
Run ID	`ade_run_id_findRunIds`	Query run ids stored in the target environment.		✅
Run ID	`ade_run_id_getLoadStatus`	Get load status for a given load id.		✅

Tool outputs

By default, tool outputs use TOON format for a more compact representation.

To get plain JSON instead, add the following header to your MCP connection config:

"X-OUTPUT-ONLY-JSON": "true"