Question 1

What is Archy?

Accepted Answer

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.

Question 2

What is an MCP Server?

Accepted Answer

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).

Question 3

What diagram types does Archy support?

Accepted Answer

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.

Question 4

What are the prerequisites for installing Archy?

Accepted Answer

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

Question 5

How do I install Archy from source?

Accepted Answer

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

Question 6

What does the `npm run install-mcp` command do?

Accepted Answer

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

Question 7

Can I configure Archy using environment variables?

Accepted Answer

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

Question 8

What is OpenRouter integration in Archy?

Accepted Answer

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

Question 9

How do I use the AI-powered tools?

Accepted Answer

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

Question 10

What image formats can Archy export diagrams to?

Accepted Answer

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

Question 11

What is repository evolution tracking?

Accepted Answer

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

Question 12

How do I use Archy with an MCP client?

Accepted Answer

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

Question 13

What are some of the available tools in Archy?

Accepted Answer

Some available tools include `generate_diagram_from_text`, `generate_diagram_from_github`, and `list_supported_diagram_types`.

Question 14

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

Accepted Answer

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

Question 15

Can Archy show differences between two versions of code?

Accepted Answer

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

Question 16

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

Accepted Answer

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

Question 17

How do I run Archy in development mode?

Accepted Answer

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

Question 18

What are the key TypeScript features used in Archy?

Accepted Answer

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

Archy Architectural Diagram Builder

Resources

Project Details

Recomended MCP Servers

Featured Templates

Speech to Text

AI Chatbot Starter Kit v0.1

Service ERP

AI-Powered Product List Manager

Image to text with Claude 3

AI Video Generator

Start your free trial