Documentation

Read the YAML reference or open an example to see how a document is written.

• Getting started

  Create a document, add a diagram and reuse a service across documents.

• Objects and references

  Store a service once and reference it in the documents that use it.

• Connect an AI agent

  Connect your editor to the hosted ArchDocs MCP server with browser sign-in.

• Claude Code setup

  Add ArchDocs as a remote HTTP MCP server in Claude Code.

• Cursor setup

  Configure the ArchDocs remote MCP server in Cursor and sign in through your browser.

• Codex setup

  Add the ArchDocs HTTP MCP server to Codex and authenticate with OAuth.

• VS Code setup

  Connect VS Code to ArchDocs over HTTP and complete browser authentication.

• MCP tool reference

  Inputs and effects of the ArchDocs MCP document, object and space tools.

• DSL Construct Reference

  YAML syntax and examples for architecture documents.

• API Endpoint

  YAML syntax and examples for architecture documents.

• C4 Boundary

  YAML syntax and examples for architecture documents.

• C4 Node

  YAML syntax and examples for architecture documents.

• Cloud Container

  YAML syntax and examples for architecture documents.

• Cloud Resource

  YAML syntax and examples for architecture documents.

• ERD Entity

  YAML syntax and examples for architecture documents.

• Worked example: Cadence

  YAML syntax and examples for architecture documents.

• Authoring documents as YAML in the app

  YAML syntax and examples for architecture documents.

• Mermaid import and export

  YAML syntax and examples for architecture documents.

• Raw element

  YAML syntax and examples for architecture documents.

• Reference

  YAML syntax and examples for architecture documents.

• Sequence Diagram

  YAML syntax and examples for architecture documents.

• Shape

  YAML syntax and examples for architecture documents.

• Text

  YAML syntax and examples for architecture documents.