View as Markdown

Astronomer Integration

Manage Astro organizations, workspaces, deployments, clusters, and deploy history via the Astro API v1

The Astronomer integration provides access to manage Astro organizations, workspaces, deployments, clusters, and deploy history via the Astro API v1 through the Integrate MCP server.

Installation

The Astronomer integration is included with the SDK:

import { astronomerIntegration } from "integrate-sdk/server";

Setup

Add Astronomer to your server configuration. Provide credentials via environment variables or integration config:

import { createMCPServer, astronomerIntegration } from "integrate-sdk/server";
 
export const { client: serverClient } = createMCPServer({
  apiKey: process.env.INTEGRATE_API_KEY,
  integrations: [
    astronomerIntegration({
      // See configuration options below
    }),
  ],
});

Client-Side Usage

import { client } from "integrate-sdk";
 
const result = await client.astronomer.getSelf({});
 
console.log(result);

Environment Variables

  • ASTRONOMER_API_KEY (when supported by this integration)

Configuration Options

export interface AstronomerIntegrationOptions {
  /** Astro organization, workspace, or deployment API token (defaults to ASTRO_API_TOKEN or ASTRONOMER_API_TOKEN) */
  apiToken?: string;

Tools

astronomer_get_self

Get self

export interface AstronomerGetSelfParams { create_if_not_exist?: boolean }

astronomer_list_organizations

List organizations

export interface AstronomerListOrganizationsParams {
    product_plan?: string;

astronomer_get_organization

Get organization

export interface AstronomerGetOrganizationParams {
    organization_id: string;

astronomer_list_workspaces

List workspaces

export interface AstronomerListWorkspacesParams {
    organization_id: string;

astronomer_get_workspace

Get workspace

export interface AstronomerGetWorkspaceParams { organization_id: string;

astronomer_list_clusters

List clusters

export interface AstronomerListClustersParams {
    organization_id: string;

astronomer_get_cluster

Get cluster

export interface AstronomerGetClusterParams { organization_id: string;

astronomer_list_deployments

List deployments

export interface AstronomerListDeploymentsParams {
    organization_id: string;

astronomer_get_deployment

Get deployment

export interface AstronomerGetDeploymentParams { organization_id: string;

astronomer_create_deployment

Create deployment

export interface AstronomerCreateDeploymentParams {
    organization_id: string;

astronomer_update_deployment

Update deployment

export interface AstronomerUpdateDeploymentParams {
    organization_id: string;

astronomer_list_deploys

List deploys

export interface AstronomerListDeploysParams {
    organization_id: string;

astronomer_get_deploy

Get deploy

export interface AstronomerGetDeployParams {
    organization_id: string;

Notes

  • Category: Engineering
  • Authentication mode: API key