Server MCP - Archyl Docs

Collega assistenti AI come Claude, Cursor e VS Code alla tua architettura — 189 strumenti che coprono il modello C4, ADR, contratti, conformità, drift, DORA e altro ancora

Server MCP

Archyl fornisce un server Model Context Protocol (MCP) che consente agli assistenti AI di interagire con la tua documentazione architetturale. Questo permette un'esplorazione e documentazione dell'architettura potenziate dall'AI.

Cos'è MCP?

Il Model Context Protocol (MCP) è un protocollo aperto che consente agli assistenti AI di accedere in modo sicuro a strumenti e fonti di dati esterne. Con il server MCP di Archyl, il tuo assistente AI può:

  • Esplorare e interrogare i tuoi progetti e il loro modello C4 completo
  • Creare e modificare elementi architetturali, relazioni e diagrammi
  • Leggere e scrivere ADR, documentazione, contratti API e canali di eventi
  • Verificare regole di conformità, punteggi di drift, metriche DORA e ownership prima di scrivere codice
  • Tracciare release, richieste di modifica, commenti e cronologia

Client supportati

Il server MCP di Archyl funziona con:

  • Antigravity - IDE potenziato dall'AI di Google
  • Claude Code - Strumento CLI di Anthropic
  • Claude Desktop - Applicazione desktop di Claude
  • Cursor - Editor di codice AI-first
  • OpenAI Codex - Assistente di programmazione AI di OpenAI
  • VS Code - Con GitHub Copilot Chat
  • Warp - Terminale moderno con integrazione AI
  • Windsurf - IDE potenziato dall'AI di Codeium

Autenticazione

Chiave API (consigliata)

La maggior parte dei client si autentica con una chiave API. A seconda dello strumento che utilizzi:

  • Strumenti con supporto header (Claude Code, Cursor, Warp, Windsurf, Antigravity): Usa l'header X-API-Key
  • Strumenti senza supporto header (Claude Desktop, VS Code, OpenAI Codex): Usa il parametro query ?apiKey=YOUR_API_KEY nell'URL

Genera una chiave API dalla pagina Profilo → Chiavi API.

Gli scope della chiave determinano cosa può fare l'assistente: una chiave in sola lettura può chiamare tutti gli strumenti list_* e get_*, mentre create_*, update_*, delete_* e import_dsl richiedono una chiave con scope di scrittura. Fornire al tuo agente una chiave in sola lettura è il modo più semplice per lasciargli esplorare la tua architettura senza che possa modificarla.

OAuth 2.1

Il server implementa anche OAuth 2.1 con registrazione dinamica dei client, per i client che si connettono tramite accesso dal browser invece che con una chiave incollata (gli scope mcp:read e mcp:write rispecchiano gli scope delle chiavi API descritti sopra). Punta un client di questo tipo allo stesso endpoint e scoprirà automaticamente il flusso tramite:

https://api.archyl.com/.well-known/oauth-authorization-server
https://api.archyl.com/.well-known/oauth-protected-resource

Configurazione

Antigravity

  1. Apri Antigravity e clicca sul menu "..." nel pannello Agent
  2. Seleziona "MCP Servers" > "Manage MCP Servers" > "View raw config"
  3. Aggiungi a ~/.gemini/antigravity/mcp_config.json:
{
  "mcpServers": {
    "archyl": {
      "serverUrl": "https://api.archyl.com/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      }
    }
  }
}
  1. Riavvia Antigravity per applicare le modifiche

Nota: Antigravity utilizza serverUrl invece di url per i server MCP basati su HTTP.

Claude Code

Crea un file .mcp.json nella root del tuo progetto:

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

Avvia Claude Code - rileverà automaticamente il server MCP.

Claude Desktop

  1. Apri le impostazioni di Claude Desktop
  2. Vai su Developer → MCP Servers
  3. Clicca su "Add Server" e aggiungi:
{
  "mcpServers": {
    "archyl": {
      "url": "https://api.archyl.com/mcp?apiKey=YOUR_API_KEY"
    }
  }
}
  1. Riavvia Claude Desktop

Nota: I connettori remoti di Claude Desktop non supportano header personalizzati, quindi la chiave API deve essere passata come parametro query nell'URL.

Cursor

Crea un file .cursor/mcp.json nel tuo progetto:

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

Riavvia Cursor per caricare il server MCP.

OpenAI Codex

Apri o crea ~/.codex/config.toml e aggiungi:

[mcp_servers.archyl]
url = "https://api.archyl.com/mcp?apiKey=YOUR_API_KEY"

Riavvia Codex CLI o IDE per applicare le modifiche.

VS Code

  1. Apri le impostazioni di VS Code (Cmd/Ctrl + ,)
  2. Cerca "MCP" e clicca su "Edit in settings.json"
  3. Aggiungi:
{
  "mcp": {
    "servers": {
      "archyl": {
        "url": "https://api.archyl.com/mcp?apiKey=YOUR_API_KEY"
      }
    }
  }
}

Warp

  1. Apri Warp e vai su Settings > MCP Servers
  2. Clicca su "Add Server" e incolla la configurazione:
{
  "archyl": {
    "url": "https://api.archyl.com/mcp",
    "headers": {
      "X-API-Key": "YOUR_API_KEY"
    }
  }
}
  1. Riavvia Warp per applicare le modifiche

Windsurf

Apri il file di configurazione MCP in ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "archyl": {
      "serverUrl": "https://api.archyl.com/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      }
    }
  }
}

Riavvia Windsurf per applicare le modifiche.

Riferimento degli strumenti

Il server espone 189 strumenti. Seguono uno schema di denominazione prevedibile, quindi un assistente riesce di solito a indovinare quello giusto:

Prefisso Cosa fa Scope necessario
list_* Elenca gli elementi di un tipo, di solito all'interno di un progetto lettura
get_* Recupera un singolo elemento completo, con i suoi collegamenti lettura
create_* Crea un nuovo elemento scrittura
update_* Modifica un elemento esistente scrittura
delete_* Rimuove un elemento (e i suoi dipendenti) scrittura
link_* / unlink_* Collega o scollega un artefatto a un elemento C4 scrittura

La maggior parte degli strumenti con ambito progetto richiede un projectId; gli strumenti con ambito elemento richiedono un elementId più un elementType (il livello C4: 1 = sistema, 2 = container, 3 = componente, 4 = codice). Chiedi al tuo assistente di chiamare prima list_projects — da lì recupererà gli ID di cui ha bisogno.

Il tuo client scopre automaticamente questo elenco tramite tools/list, quindi è sempre allineato con il server. Le tabelle seguenti servono agli umani per decidere cosa chiedere.

Profili di strumenti

189 strumenti sono più di quanto serva a un agente di codifica per un compito delimitato — annunciarli tutti costa contesto. Aggiungi ?profile=coding all'URL MCP (o invia l'header X-Archyl-Tool-Profile: coding) per ridurre la superficie a 16 strumenti: contesto mirato al compito, il ciclo di sessioni di lavoro del harness e i controlli di conformità/diff. Ometti il parametro (o usa profile=full) per il catalogo completo.

Contesto per l'agente (4)

Inizia da qui: questi strumenti danno a un assistente il quadro architetturale in una sola chiamata, invece che in molte.

Tool Description
get_agent_context Get the complete architectural context for a project: C4 model, ADRs, tech stack, guardrails, API contracts, and event channels
find_relevant_context Given a natural-language task, return ONLY the architecture elements relevant to it (ranked), their connected neighbours, the decisions (ADRs) and…
get_project_c4_model Get the complete C4 model for a project including all systems, containers, components, code elements, and relationships
impact_of Compute the blast radius of changing a C4 element: the dependents that are AFFECTED if it changes, the dependencies it relies on, and the distinct…

Sessioni di lavoro Harness (8)

Il ciclo di lavoro governato per gli agenti di codifica: dichiara un'unità di lavoro per ottenere contesto mirato e lock consultivi, invia un heartbeat durante il lavoro e concludi con un esito che può aprire una richiesta di modifica dell'architettura. In più la memoria di progetto: memorizza fatti per chi lavorerà dopo e richiama ciò che le sessioni precedenti hanno appreso.

Tool Description
plan_work Produce an architecture-aware implementation plan for a task: ordered steps grounded in the documented C4 model, with the ADRs and guardrails that…
start_work_session Declare a unit of work BEFORE starting it
heartbeat_work_session Mark an active work session as still alive
finish_work_session Close a work session with what actually happened: a summary, the decisions worth recording, and follow-ups
list_work_sessions List a project's harness work sessions — who is (or was) working on what, with the elements each session holds leases on
remember Store a memory for future workers: a convention, a pitfall, or a fact worth knowing about an element or the project
recall Search the project's memory: session outcomes, notes, conventions and pitfalls left by previous agents and humans
confirm_memory Re-attest a memory you just verified in the code or at runtime: bumps its confirmation count and resets its freshness, so it keeps outranking stale…

Progetti (7)

Tool Description
list_projects List all architecture projects the user has access to
get_project Get detailed information about a specific project including its C4 model overview
create_project Create a new architecture project
update_project Update an existing project's details
delete_project Delete a project and all its associated data (systems, containers, components, relationships)
get_project_settings Get the settings for a project (discovery config, PR settings, layout preferences, etc.)
update_project_settings Update project settings such as diagram layout, code level visibility, request mode, etc

Organizzazioni e team (5)

Tool Description
list_organizations List organizations the user belongs to
get_organization Get detailed information about an organization
list_teams List teams in an organization
get_team Get detailed information about a team
create_team Create a new team in an organization

Elementi C4 (15)

Sistemi (livello 1), container (livello 2), componenti (livello 3) ed elementi di codice (livello 4).

Tool Description
list_systems List all C4 Systems in a project
create_system Create a new C4 System (Level 1) in a project
update_system Update an existing C4 System
delete_system Delete a C4 System and all its containers, components, and code elements
list_containers List all C4 Containers in a system
create_container Create a new C4 Container (Level 2) in a system
update_container Update an existing C4 Container
delete_container Delete a C4 Container and all its components and code elements
list_components List all C4 Components in a container
create_component Create a new C4 Component (Level 3) in a container
update_component Update an existing C4 Component
delete_component Delete a C4 Component and all its code elements
create_code_element Create a new C4 Code Element (Level 4) in a component
update_code_element Update an existing C4 Code Element
delete_code_element Delete a C4 Code Element

Relazioni (4)

Tool Description
list_relationships List all relationships in a project
create_relationship Create a relationship (connection) between two C4 elements
update_relationship Update an existing relationship
delete_relationship Delete a relationship between C4 elements

Layout dei diagrammi e overlay (5)

Tool Description
update_positions Batch update positions of C4 elements on the diagram (systems, containers, components, code elements, overlays)
list_overlays List all overlays in a project
create_overlay Create a visual overlay (grouping) on the diagram
update_overlay Update an existing overlay
delete_overlay Delete an overlay

Documentazione (11)

Tool Description
list_documentation List project documentation
get_documentation Get detailed information about a documentation item
create_documentation Create a new documentation item
update_documentation Update an existing documentation item
delete_documentation Delete a documentation item
move_documentation Move a documentation item to a folder and/or position
list_documentation_folders List folders for a project
create_documentation_folder Create a new documentation folder
update_documentation_folder Rename a documentation folder
move_documentation_folder Move a documentation folder to a new parent and/or position
delete_documentation_folder Delete a documentation folder (children and docs are reparented to the parent folder)

Architecture Decision Record (6)

Tool Description
list_adrs List Architecture Decision Records in a project
get_adr Get detailed information about an Architecture Decision Record
create_adr Create a new Architecture Decision Record
update_adr Update an existing Architecture Decision Record
delete_adr Delete an Architecture Decision Record
link_adr_to_element Link an ADR to a C4 element (system, container, component, or code)

Contratti API (8)

Contratti OpenAPI, gRPC, GraphQL, AsyncAPI e per strumenti MCP.

Tool Description
list_api_contracts List API contracts for a project
list_api_contracts_by_element List API contracts linked to a specific C4 element
get_api_contract Get a single API contract with its links to C4 elements
create_api_contract Create a new API contract (OpenAPI, gRPC, GraphQL, AsyncAPI, or MCP tools)
update_api_contract Update an existing API contract
delete_api_contract Delete an API contract and all its links
link_api_contract Link an API contract to a C4 element (system, container, component, or code)
unlink_api_contract Remove a link between an API contract and a C4 element

Canali di eventi (8)

Tool Description
list_event_channels List event channels (producers/consumers) for a project
list_event_channels_by_element List event channels linked to a specific C4 element
get_event_channel Get a single event channel with its links to C4 elements
create_event_channel Create a new event channel (producer or consumer)
update_event_channel Update an existing event channel
delete_event_channel Delete an event channel and all its links
link_event_channel Link an event channel to a C4 element (system, container, component, or code)
unlink_event_channel Remove a link between an event channel and a C4 element

Flussi e lavagne (8)

Tool Description
list_flows List user/system flows in the organization
get_flow Get detailed information about a flow including its steps
create_flow Create a new user/system flow diagram
delete_flow Delete a flow
list_whiteboards List whiteboards in the organization
get_whiteboard Get detailed information about a whiteboard
create_whiteboard Create a new whiteboard for free-form diagramming
delete_whiteboard Delete a whiteboard

Commenti e discussioni (11)

Tool Description
list_comments List all comments for a project with pagination
list_comments_by_element List comments for a specific C4 element
get_comment Get a single comment by ID with its replies
get_comment_count Get the number of comments for a C4 element
create_comment Create a new comment on a project or C4 element
update_comment Update an existing comment (only the author can update)
delete_comment Delete a comment (only the author can delete)
resolve_comment Mark a comment thread as resolved
unresolve_comment Mark a comment thread as unresolved (reopen)
add_comment_reaction Add a reaction emoji to a comment
remove_comment_reaction Remove a reaction emoji from a comment

Ownership (6)

Tool Description
who_owns Find the user and team owners of a C4 element
get_ownership_map Get the global ownership map showing all C4 elements across the organization with their team and user ownership data, plus coverage statistics
get_element_owners Get the owners of a C4 element (system, container, component, or code element)
set_element_owners Set the owners of a C4 element (replaces existing owners)
add_element_owner Add a single owner to a C4 element
remove_element_owner Remove an owner from a C4 element

Tecnologie e radar (10)

Tool Description
list_technologies List all technologies in the organization, optionally filtered by category or search term
get_technology Get detailed information about a specific technology
create_technology Create a new technology in the organization
update_technology Update an existing technology
delete_technology Delete a technology and all its element/relationship links
get_technology_radar Get the technology radar data showing all technologies with their usage counts across elements and relationships
get_element_technologies Get technologies linked to a C4 element (system, container, or component)
set_element_technologies Set the technologies linked to a C4 element (replaces existing links)
get_relationship_technologies Get technologies linked to a C4 relationship
set_relationship_technologies Set the technologies linked to a C4 relationship (replaces existing links)

Release e ambienti (10)

Tool Description
list_releases List releases for a project with optional filters
get_release Get detailed information about a specific release
create_release Create a new release for a project
update_release Update an existing release
delete_release Delete a release
list_environments List deployment environments for a project, ordered by position
create_environment Create a new deployment environment for a project
update_environment Update an existing deployment environment
delete_environment Delete a deployment environment
reorder_environments Reorder environments for a project by providing the environment IDs in the desired order

Richieste di modifica architetturale (6)

Tool Description
list_requests List architecture change requests for a project
get_request Get detailed information about an architecture change request including its changes and reviews
create_request Create a new architecture change request
update_request Update the title or description of an architecture change request (author only, not merged)
list_request_changes List all changes in an architecture change request
list_request_reviews List all reviews for an architecture change request

Regole di conformità (9)

Tool Description
list_conformance_rules List architecture conformance rules for the organization, with optional project filter
get_conformance_rule Get detailed information about a conformance rule
create_conformance_rule Create a new architecture conformance rule
update_conformance_rule Update a conformance rule's name, description, severity, or config
delete_conformance_rule Delete a conformance rule
run_conformance_check Run conformance rules against changed files and return a violation report
list_conformance_checks List recent conformance checks for a project
get_conformance_report Get the full report for a conformance check, including all violations
get_conformance_stats Get conformance statistics for a project (total checks, pass/fail rate, latest status)

Rilevamento del drift (4)

Tool Description
get_drift_score Get the latest drift score for a project
compute_drift_score Trigger a drift score computation for a project
get_drift_details Get the per-element drift breakdown for a specific score computation
get_drift_history Get the drift score trend over time for a project

Metriche DORA, ROI e previsioni (4)

Tool Description
get_dora_metrics Calculate DORA metrics (Deployment Frequency, Lead Time for Changes, Change Failure Rate, Mean Time to Restore) for a project
get_dora_trend Get DORA metrics trend over time, bucketed by day, week, or month
compute_architecture_roi Quantify the financial impact of architecture decisions
get_predictions Analyze drift trends, DORA trajectories, conformance decay, and complexity growth to forecast risks and recommend preventive actions

Cronologia e time travel (5)

Tool Description
list_history List change history entries for the organization, optionally filtered by project, entity name, user, or action
list_versions List all time-travel versions (snapshots) for a project, ordered by version number descending
get_version Get a specific version by project ID and version number, including the full snapshot data and changes
diff_version Compare a version with another version or the current live state
analyze_architecture_diff AI-powered analysis of a git diff to detect architecture changes

Insight (3)

Tool Description
list_insights List AI-generated architecture insights
get_insight Get detailed information about an insight
silence_insight Silence an insight to hide it from the list

Marketplace e widget (15)

Tool Description
list_marketplace_products List all available marketplace integration products (Datadog, GitHub, GitLab, SonarQube, etc.)
get_marketplace_product Get detailed information about a marketplace product including its configuration schema
list_marketplace_connections List all configured marketplace connections for the organization
get_marketplace_connection Get detailed information about a specific marketplace connection
create_marketplace_connection Create a new marketplace connection to an integration product
update_marketplace_connection Update an existing marketplace connection
delete_marketplace_connection Delete a marketplace connection and all its associated widgets
list_marketplace_widgets List marketplace widgets for a project
list_marketplace_widgets_by_element List marketplace widgets linked to a specific C4 element
get_marketplace_widget Get detailed information about a specific marketplace widget
create_marketplace_widget Create a new marketplace widget for a project
update_marketplace_widget Update an existing marketplace widget
delete_marketplace_widget Delete a marketplace widget
list_organization_widgets List marketplace widgets scoped to the organization (not project-specific)
create_organization_widget Create a new marketplace widget scoped to the organization (not project-specific)

Webhook (7)

Tool Description
list_webhook_notifications List all outgoing webhook notification configurations for the organization
get_webhook_notification Get detailed information about a specific webhook notification configuration
create_webhook_notification Create a new outgoing webhook notification
update_webhook_notification Update an existing webhook notification configuration
delete_webhook_notification Delete a webhook notification and all its delivery history
test_webhook_notification Send a test event to a webhook endpoint to verify it is configured correctly
list_webhook_deliveries List recent delivery history for a webhook notification, including status and response codes

Architettura a livello di organizzazione (9)

Viste cross-progetto e artefatti a livello di organizzazione.

Tool Description
list_global_systems List all C4 systems across all projects in the organization (global architecture view)
list_global_relationships List all C4 relationships visible in the global architecture view
list_global_adrs List organization-level Architecture Decision Records (not scoped to a specific project)
create_global_adr Create an organization-level Architecture Decision Record
list_global_docs List organization-level documentation (not scoped to a specific project)
create_global_doc Create an organization-level documentation page
list_global_api_contracts List organization-level API contracts (not scoped to a specific project)
create_global_api_contract Create an organization-level API contract
list_global_comments List organization-level discussion comments (not scoped to a specific project)

Architecture as code (1)

Tool Description
import_dsl Import architecture from a DSL format (Archyl YAML, Structurizr DSL, LikeC4, IcePanel JSON, or Backstage catalog JSON) into a project

Esempi di Conversazione

Esplorare l'Architettura

Tu: "Quali sistemi ci sono nel mio progetto e-commerce?"

AI: Usa lo strumento list_systems "Il tuo progetto e-commerce ha 4 sistemi: Web Store, Payment Service, Inventory System e Notification Service..."

Creare Elementi

Tu: "Aggiungi un nuovo container chiamato Redis Cache al sistema Web Store per lo storage delle sessioni"

AI: Usa lo strumento create_container "Ho creato il container Redis Cache nel sistema Web Store con la descrizione 'Cache in-memory per lo storage delle sessioni'."

Documentazione

Tu: "Crea un ADR per la nostra decisione di usare PostgreSQL invece di MongoDB"

AI: Usa lo strumento create_adr "Ho creato l'ADR-001: Selezione Tecnologia Database, documentando la decisione di usare PostgreSQL per la sua conformità ACID e flessibilità nelle query..."

Prima di scrivere codice

Tu: "Sto per aggiungere il rate limiting al flusso di checkout. Cosa dovrei sapere?"

AI: Usa find_relevant_context e impact_of "Il checkout coinvolge l'API Gateway e il servizio Orders. Modificare il gateway impatta 6 container a valle. L'ADR-014 impone già Redis per il throttling e una regola di conformità vieta nuove dipendenze dal vecchio Session store..."

Verifica di governance

Tu: "Ci stiamo allontanando dall'architettura documentata?"

AI: Usa get_drift_score e run_conformance_check "Il punteggio di drift è 82% (in calo dal 91% del mese scorso). Due violazioni: il servizio Search chiama direttamente il database Orders e Payments usa un client HTTP non approvato..."

Endpoint

Streamable HTTP (MCP)

https://api.archyl.com/mcp

Usa questo endpoint per connettere il tuo assistente AI alla documentazione architetturale di Archyl. Supporta il protocollo di trasporto Streamable HTTP.

Risoluzione Problemi

Connessione Fallita

  • Verifica che la tua chiave API sia valida
  • Assicurati che l'URL dell'endpoint sia corretto
  • Controlla la tua connessione di rete

Autenticazione Fallita

  • Per strumenti con supporto header: Verifica che l'header X-API-Key sia impostato correttamente
  • Per strumenti senza supporto header: Verifica che il parametro query ?apiKey= sia nell'URL
  • Assicurati che la tua chiave API non sia scaduta

Strumento Non Trovato

  • Assicurati di usare il nome corretto dello strumento — consulta il riferimento degli strumenti, oppure chiedi al tuo client di aggiornare la sua lista di strumenti
  • Alcuni client mettono in cache tools/list; riavvia il client dopo un aggiornamento

Strumenti di Scrittura Rifiutati

  • create_*, update_*, delete_* e import_dsl richiedono una chiave API con scope di scrittura — una chiave in sola lettura può chiamare solo list_* e get_*
  • Controlla il tuo piano di abbonamento: alcune funzionalità (webhook, connessioni al marketplace, esecuzioni di agent gestiti) dipendono dal piano

Problemi Specifici di Antigravity

  • Assicurati di usare serverUrl (non url) nella configurazione
  • La posizione del file di configurazione è ~/.gemini/antigravity/mcp_config.json

Problemi Specifici di OpenAI Codex

  • Assicurati che la sintassi TOML sia corretta in ~/.codex/config.toml
  • Usa [mcp_servers.archyl] come nome della tabella

Problemi Specifici di Warp

  • Vai su Settings > MCP Servers per gestire le configurazioni
  • Riavvia Warp dopo aver modificato la configurazione

Best Practice

Sii Specifico

Quando chiedi al tuo AI di modificare l'architettura, sii specifico:

  • Includi i nomi dei progetti
  • Specifica i tipi di elemento
  • Fornisci descrizioni

Revisiona le Modifiche

Revisiona sempre gli elementi creati dall'AI:

  • Verifica che nomi e descrizioni siano accurati
  • Controlla che le relazioni siano corrette
  • Aggiorna se necessario

Usa per l'Esplorazione

MCP è ottimo per:

  • Esplorare rapidamente architetture complesse
  • Generare documentazione iniziale
  • Rispondere a domande sui tuoi sistemi