Coding Agent Plugin - Archyl Docs

Install and use the Archyl coding agent plugin to manage your architecture directly from Claude Code, Codex, or any compatible coding agent

Coding Agent Plugin

The Archyl Developer Plugin lets you manage your entire C4 architecture model directly from your coding agent — Claude Code, Codex, or any compatible tool. Instead of switching between your editor and the Archyl dashboard, you can create systems, containers, components, ADRs, conformance rules, and more without leaving your terminal.

The plugin is open source and available at github.com/archyl-com/agent-skills.

What You Can Do

The plugin gives your agent deep knowledge of Archyl's 200+ MCP tools across these domains:

Domain Capabilities
C4 Modeling Create and manage systems, containers, components, code elements, and relationships
Documentation Architecture Decision Records, project docs, user/system flows, AI insights
Governance Conformance rules, drift detection, DORA metrics, ownership mapping
Operations Releases, environments, API contracts, event channels, technology radar
Collaboration Comments, change requests, whiteboards, team management
History Snapshots, time travel, architecture diffing, audit logs
Integrations Webhooks, marketplace widgets, global architecture views

Prerequisites

  • An Archyl account with API access
  • An API key (get one from Settings → API Keys in the Archyl dashboard)
  • Claude Code, Codex, or a compatible coding agent

Installation

Step 1: Add the Marketplace

Run the following command in Claude Code:

/plugin marketplace add archyl-com/agent-skills

Then open the plugin manager to configure auto-updates:

  1. Run /plugin
  2. Select Marketplaces
  3. Choose archyl-marketplace from the list
  4. Select Enable auto-update or Disable auto-update

Step 2: Install the Plugin

/plugin install archyl-developer@archyl-com-agent-skills

Restart Claude Code after installation.

Step 3: Configure the MCP Server

Add the Archyl MCP server to your project's .mcp.json:

{
    "mcpServers": {
        "archyl": {
            "type": "http",
            "url": "https://api.archyl.com/mcp",
            "headers": {
                "X-API-Key": "arch_your_api_key_here"
            }
        }
    }
}

Replace arch_your_api_key_here with your actual API key from the Archyl dashboard.

Other Coding Agents

The plugin content is compatible with any agent that supports the plugin format. You can also use the skill files directly from the archyl-developer plugin directory in the repository.

Common Workflows

Once installed, you can ask your coding agent to perform architecture tasks in natural language. Here are some common workflows:

Document a New Project

Ask your agent to scaffold your architecture model:

Create a new Archyl project for our e-commerce platform.
Add the main systems: WebApp, PaymentService, and PostgreSQL Database.
Then create containers for the API server and React frontend inside WebApp.

The agent will call the appropriate MCP tools (create_project, create_system, create_container) and wire everything together.

Analyze Existing Architecture

Get the full C4 model for my project and summarize the architecture.
Check the drift score — is the documentation still accurate?
Show me any open architecture insights.

Enforce Architecture Rules

Create a conformance rule that prevents any container from having
more than 10 direct dependencies. Then run a conformance check.

Record Architecture Decisions

Create an ADR titled "Migrate from REST to gRPC for internal services".
Set it as proposed, explain the context around latency requirements,
and link it to the ApiGateway and PaymentService containers.

Check Deployment Performance

Show me the DORA metrics for the last month.
What's our deployment frequency and lead time trend?

Manage Technology Radar

Show me the current technology radar.
Add "Temporal" as an adopted workflow orchestration technology
and tag it on the OrderProcessing container.

How It Works

The plugin provides your coding agent with structured knowledge about every Archyl MCP tool — including parameters, expected values, and best practices. When you ask your agent to perform an architecture task, it:

  1. Identifies which MCP tools to call
  2. Constructs the correct parameters (project IDs, element types, relationship types)
  3. Chains multiple calls together for complex workflows
  4. Returns a summary of what was created or modified

The agent always starts by calling list_projects to discover available projects and get the projectId needed for subsequent operations.

C4 Model Reference

The plugin understands all 4 levels of the C4 model:

Level Element Example
1 System "Payment Platform", "Email Service"
2 Container "API Server", "PostgreSQL Database", "React Frontend"
3 Component "AuthService", "PaymentProcessor", "UserRepository"
4 Code "PaymentGateway interface", "processPayment()"

Naming Conventions

The agent follows these naming rules when creating elements:

  • Systems: PascalCase, descriptive (PaymentPlatform, NotificationService)
  • Containers: PascalCase with type hint (ApiServer, PostgresDatabase, RedisCache)
  • Components: PascalCase, module-oriented (AuthService, PaymentProcessor)
  • Code Elements: Exact symbol names from source code

Relationship Types

When connecting elements, the agent uses the appropriate relationship type:

Type Use Case
uses General dependency between systems
calls Synchronous HTTP/gRPC calls
sends_to / consumes_from Async messaging (queues, events)
reads_from / writes_to Database access
implements / extends Code-level inheritance

Contributing

The plugin is open source. You can contribute by:

  • Fixing tool names, parameters, or descriptions
  • Adding coverage for new Archyl features
  • Improving workflow examples
  • Adding reference files for missing domains

See the contributing guide for details.