AI Integration / Setup Guide

MCP Server Setup Guide

Install the Albumi MCP server, connect it to your AI agent, and start working with your architecture data.

Prerequisites

  • Node.js 20+node --version should show v20 or higher
  • Albumi accountsign up for early access if you don't have one
  • An MCP-compatible AI agent — Claude Code, Cursor, or any MCP client

Install & Authenticate

# Authenticate via browser (one-time)

npx @albumi/mcp login

This opens your browser for authentication. After you log in, a token is saved to ~/.albumi/credentials.json. You don't need to log in again unless the token expires.

Configure: Claude Code

# Add MCP server to Claude Code

claude mcp add albumi -- npx @albumi/mcp

That's it. Claude Code now has access to Albumi tools. You can verify with:

claude mcp list

You should see albumi in the list with 4 tools available.

Configure: Cursor

Add to your project's .cursor/mcp.json:

{
  "mcpServers": {
    "albumi": {
      "command": "npx",
      "args": ["@albumi/mcp"]
    }
  }
}

Restart Cursor. The Albumi tools appear in the agent sidebar.

Configure: Other MCP Agents

For any MCP-compatible agent, the server command is:

npx @albumi/mcp

Transport: stdio. The server reads from stdin and writes to stdout using the MCP protocol. Refer to your agent's documentation for how to add stdio MCP servers.

For CI/CD or token-based auth (no browser login), set environment variables:

{
  "mcpServers": {
    "albumi": {
      "command": "npx",
      "args": ["@albumi/mcp"],
      "env": {
        "ALBUMI_API_URL": "https://my.albumi.app",
        "ALBUMI_API_TOKEN": "your-api-token"
      }
    }
  }
}

Pull a Workspace

Ask your agent to pull your workspace. The agent will list available workspaces, ask you to pick one, and download it as a JSON file.

"Pull my Albumi workspace"

The workspace JSON contains all your architecture data: organizations, business capabilities, data objects, IT components, applications (with interfaces), integrations, and initiatives. The agent reads the file and works with it directly — you don't need to touch the JSON yourself.

Generate Architecture from Documents

The MCP server includes a generate_workspace prompt with complete schema documentation. Your agent knows the full workspace format — all entity types, required fields, validation rules, and enum values.

Feed your agent any source material and ask it to create the architecture:

"Here's our IT landscape wiki page. Create a complete
Albumi workspace from this — applications, integrations,
data objects, and business capabilities."

"I'm attaching a spreadsheet with our application list.
Import them all into Albumi. For each app, infer
criticality and hosting type from the descriptions."

"We have 3 main systems: Salesforce (CRM), SAP (ERP),
and a custom data warehouse. Salesforce sends customer
data to SAP via REST API daily. SAP sends financial
data to the warehouse via batch file nightly. Create
the full architecture."

The agent generates the JSON with proper UUIDs, referential integrity, lifecycle metadata, and all required fields. It then validates and audits before pushing.

Validate

Validation checks three things: JSON schema compliance, referential integrity (every ID reference resolves), and circular reference detection (parentId chains).

"Validate the workspace file"

If there are errors, the agent sees them and can fix them automatically:

"Validate the workspace. If there are errors, fix them and validate again."

The agent handles the fix-validate cycle on its own — broken references, missing fields, invalid values. You only see the final result.

Audit

The audit runs 70+ deterministic checks on your architecture data. No AI judgment — these are rules-based assessments.

"Run a full audit on the workspace"

Output includes a summary and detailed findings:

Summary: 12 findings (2 critical, 5 warning, 5 info)

CRITICAL: Legacy CRM (Application)
  Active integrations depend on EOL application.
  Affected: Storefront → Legacy CRM,
            Legacy CRM → Data Warehouse

WARNING: Customer Data (DataObject)
  Classification "confidential" but integration
  uses authentication "none"

INFO: Mobile App (Application)
  Missing business criticality level

You can ask the agent to focus on specific areas:

"Show me only critical compliance findings"

"What applications have lifecycle issues?"

"Fix all data quality warnings automatically"

Push Changes

After editing, validating, and auditing, push changes back to Albumi:

"Push the workspace. Name the change request
'Initial Architecture Import'"

The agent creates an Architecture Change Request (ACR). You review and approve it in Albumi's web UI. Nothing changes in your production workspace until you explicitly approve.

Push result:
  ACR created: "Initial Architecture Import"
  ACR ID: acr-019d-08ab-...
  Entities: 5 orgs, 12 capabilities, 8 data objects,
            45 applications, 67 integrations, 3 initiatives

→ Review in Albumi UI to apply changes

Full Audit Checks Reference

All 70+ automated checks grouped by category. Each check produces findings with severity: critical warning info

Category What It Checks Checks
Structural Integrity Duplicate entity names, self-referencing parentIds, interface port direction mismatches, excessive hierarchy depth, orphaned child nodes 8
Data Quality Missing business criticality, functional/technical fit scores, data classification, descriptions, TIME classification, lifecycle dates, hosting type 10
Architecture Consistency Cloud provider set but hosting type not "cloud", SaaS apps with on-premise hosting, integration protocol mismatches, data format inconsistencies 6
Lifecycle Coherence Plan date after go-live, go-live after retirement, EOL applications with active dependencies, phase-out applications with "invest" classification, expired end-of-life dates still marked active 8
Network Analysis Integration hubs (>10 connections — single point of failure), circular data dependencies, data flow direction inconsistencies, isolated applications (no integrations) 6
Portfolio Health TIME distribution imbalance (>50% eliminate), critical applications marked for retirement, capability coverage gaps, over-concentrated capabilities (one app supports everything) 10
Compliance & Risk GDPR-relevant apps without PII data object mapping, PCI-relevant apps with insufficient auth on integrations, SOX-relevant apps without audit trails, sensitive data flowing through unauthenticated channels, restricted data without retention period 10
Technology Risk IT components past end-of-life, single-vendor concentration, technology monoculture, unsupported versions still in active use 5
Initiative Alignment Initiatives without linked applications, conflicting initiative timelines on same application, completed initiatives with unresolved impacts, in-progress initiatives past end date 5
Organizational Coverage Applications without owner, organizations with no applications, orphaned entities (no org link), capability trees without applications mapped 4
Data Governance Unclassified data objects, PII flag set without "confidential" or "restricted" classification, data objects without System of Record, multiple apps claiming SoR for same data object 5
Redundancy & Complexity Multiple applications supporting same capability (potential redundancy), integration sprawl (>5 integrations between same pair), over-connected applications (blast radius risk) 4

Environment Variables

Variable Required Description
ALBUMI_API_URL If not using CLI login Base URL of Albumi instance (e.g., https://my.albumi.app)
ALBUMI_API_TOKEN If not using CLI login Bearer token for API authentication
ALBUMI_CONFIG_DIR No Config directory for credentials (default: ~/.albumi)

Authentication priority: environment variables first, then CLI login credentials from ~/.albumi/credentials.json.

Troubleshooting

"No workspaces found"

Your token may be expired or you haven't been added to any workspace. Log in again with npx @albumi/mcp login and ensure your account has access to at least one workspace.

"Authentication failed"

Delete ~/.albumi/credentials.json and run npx @albumi/mcp login again. If using env vars, verify ALBUMI_API_TOKEN is correct.

"Tool not found" in your agent

Verify the MCP server is registered. In Claude Code: claude mcp list. In Cursor: check .cursor/mcp.json exists and Cursor has been restarted.

Large workspace takes too long

Workspaces up to 500 entities (~200 KB) should pull in under 5 seconds. If it's slower, check your network connection to the Albumi API.

Node.js version error

The MCP server requires Node.js 20+. Check with node --version. If using nvm: nvm use 20.

Questions? Check the FAQ or learn more about AI Integration.