Archyl Docs: Guides, MCP Server and API Reference

Comprehensive documentation, getting started guides, API reference, and tutorials for Archyl's architecture platform.

Getting started

  • Introduction to Archyl — Learn what Archyl is and how it helps you document your software architecture using the C4 model
  • Quickstart Guide — Get started with Archyl in 5 minutes - create your first architecture diagram
  • Core Concepts — Understand the key concepts and terminology used in Archyl

C4 model

  • C4 Model Overview — Learn about the C4 model and how Archyl implements it for architecture documentation
  • Elements & Styling — Learn about the different element types at each C4 level and how to style them
  • Relationships — Learn how to create and style relationships between architecture elements

Features

  • AI-Powered Discovery — Learn how Archyl uses AI to automatically discover and document your architecture from your codebase — including incremental updates on every push
  • Architecture Change Requests — Propose, review, and merge changes to your C4 architecture model through a structured change request workflow
  • Documentation & ADRs — Create and manage architecture documentation and Architecture Decision Records in Archyl
  • Documentation Attachments — Upload images and files to documentation pages by drag-and-drop, paste, or the attach button — stored securely in S3-compatible object storage
  • User Flows — Document user and data flows across your architecture to visualize sequences of interactions
  • Architecture as Code — Define and sync your C4 architecture using archyl.yaml — version-controlled, CI/CD-ready, and fully declarative
  • Architecture Time-lapse — Replay your project's version history as a cinematic film — elements draw themselves in, retired services get struck through, and the credits roll — then…
  • Architecture Insights — Automatically detect architectural issues and get recommendations to improve your system design
  • Sharing & Export — Share your architecture diagrams with stakeholders and export to various formats
  • API Contracts — Document and manage API specifications linked directly to your C4 architecture elements
  • Release Management — Track deployments across your architecture with automated ingestion from GitHub Actions, webhooks, and REST API
  • Marketplace Integrations — Connect external services and display live metrics, alerts, and dashboards alongside your architecture
  • Production Reality (Living Diagram) — Connect production sources like Kubernetes, Datadog, and New Relic to discover live services and dependencies, then reconcile them against your C4 model —…
  • Technology Radar — Visualize your technology landscape, track adoption levels, and manage your tech stack across all projects
  • Webhook Notifications — Receive real-time HTTP notifications when architecture changes happen in your projects
  • Ownership Map — Visualize team and user ownership across your architecture with interactive bubbles, dependency lines, and coverage tracking
  • Slack & Teams Bots — Ask Archyl about your architecture from Slack or Microsoft Teams — and let it use live MCP tools to answer and act
  • Conformance Rules (Guardrails) — Define deterministic architecture rules that validate code changes against your C4 model, technology decisions, and coding standards — no AI involved
  • GitHub Actions Integration — Run architecture conformance checks, drift scoring, context generation, and more in your CI/CD pipeline with Archyl's official GitHub Actions
  • Conformance Rule Packs — Pre-built conformance rule sets for common architecture patterns — microservices, clean architecture, event-driven, API-first, and security baseline
  • Managed Agent Runs — Dispatch autonomous AI agents that run on a schedule, connect to external services via MCP connectors, and work on your codebase with full architectural context
  • Bring Your Own AI Provider — Route every Archyl AI feature through your own provider (OpenAI, Anthropic, Google Gemini, AWS Bedrock, or any OpenAI-compatible endpoint) using your own…

Guides

  • Creating Your First Project — A step-by-step guide to creating and documenting your first architecture project in Archyl
  • Embedding Diagrams — Embed interactive Archyl diagrams in Confluence, Notion, Miro, and other platforms
  • Security — Learn how Archyl protects your data and architecture information
  • Settings & Configuration — Configure AI providers, manage subscriptions, and customize your Archyl experience
  • Coding Agent Skills — Install and use Archyl's 11 coding agent skills to validate, document, review, and optimize your architecture directly from Claude Code, Codex, or any…
  • Archyl Harness — Make any coding agent architecture-aware in five minutes: focused context, governed work sessions, guardrail enforcement, and memory that compounds across…

Git integration

Collaboration

  • Team Management — Learn how to create and manage teams in Archyl for better collaboration
  • Real-Time Whiteboard — Collaborate on architecture diagrams in real-time with your team
  • Team Architecture Digest — Send a recurring email recap of architecture activity to each team — drift, ADRs, conformance, discussions.

Api

  • API Overview — Learn about Archyl's API and how to integrate with your tools and workflows
  • Authentication — Learn how to authenticate with the Archyl API using API keys
  • MCP Server — Connect AI assistants like Claude, Cursor and VS Code to your architecture — 189 tools covering the C4 model, ADRs, contracts, conformance, drift, DORA and more
  • SDKs — Programmatic access to the Archyl API with official Node.js and Python SDKs