What is Archy?

Archy is an MCP (Model Context Protocol) server that generates architectural diagrams using Mermaid syntax. It can process both natural language descriptions and GitHub repository URLs.

What is an MCP Server?

An MCP server acts as a bridge, allowing AI models to access and interact with external data sources and tools through the Model Context Protocol (MCP).

What diagram types does Archy support?

Archy supports a wide range of Mermaid diagram types, including flowcharts, sequence diagrams, class diagrams, state diagrams, ERDs, user journeys, Gantt charts, pie charts, quadrant charts, requirement diagrams, Git graphs, and C4 diagrams.

What are the prerequisites for installing Archy?

To install Archy, you need Node.js (v16 or higher), npm (v7 or higher), and TypeScript (v5.8 or higher).

How do I install Archy from source?

Clone the repository, install dependencies using npm install, and build the project using npm run build.

What does the npm run install-mcp command do?

This script automatically configures the MCP server for both VS Code and Claude, detects the correct MCP settings locations, and updates the configuration files.

Can I configure Archy using environment variables?

Yes, Archy can be configured using the GITHUB_TOKEN for GitHub API requests and OPENROUTER_API_KEY for AI-powered diagram generation.

What is OpenRouter integration in Archy?

OpenRouter integration enhances AI-powered diagram generation, enabling features like AI-enhanced text-to-diagram generation, code-to-diagram generation, and diff visualization.

How do I use the AI-powered tools?

Sign up for an OpenRouter account, get your API key, set the OPENROUTER_API_KEY environment variable, and then run Archy.

What image formats can Archy export diagrams to?

Archy supports exporting diagrams to PNG, SVG, and PDF formats.

What is repository evolution tracking?

Archy can analyze Git repositories to track their evolution over time, track changes across multiple commits, and visualize the repository’s evolution.

How do I use Archy with an MCP client?

Add Archy to your MCP settings file with the appropriate command and arguments.

What are some of the available tools in Archy?

Some available tools include generate_diagram_from_text, generate_diagram_from_github, and list_supported_diagram_types.

What are the AI-powered tools available with OpenRouter integration?

AI-powered tools include generate_diagram_from_text_with_ai, generate_diagram_from_code, and generate_diff_diagram.

Can Archy show differences between two versions of code?

Yes, the generate_diff_diagram tool generates a Mermaid diagram showing differences between two versions of code.

How can I track the evolution of a repository over time?

You can use the generate_repository_evolution_diagram tool, providing the repository URL and other optional parameters such as file path and commit limit.

How do I run Archy in development mode?

Use the command npm run dev to run the server in development mode with automatic reloading.

What are the key TypeScript features used in Archy?

Key TypeScript features include ES2020 target, NodeNext module resolution, declaration files generation, and source maps for debugging.