phxdev1/archy-mcp

Developer tools

이 페이지는 AI로 자동 번역되었습니다. 기술적인 세부 사항은 원문을 확인하세요. 원문 보기

30 stars 8 forks 품질 66 트렌드 11Apache-2.0

Repository Install

Archy is an MCP (Model Context Protocol) server that generates architectural diagrams using Mermaid syntax.

개요

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 to create various types of diagrams. - Generate diagrams from text descriptions - Generate diagrams from GitHub repositories - Support for all Mermaid diagram types: - Flowcharts - Sequence Diagrams - Class Diagrams - State Diagrams - Entity Relationship Diagrams - User Journeys - Gantt Charts - Pie Charts - Quadrant Charts - Requirement Diagrams - Git Graphs - C4 Diagrams - Node.js (v16 or higher) - npm (v7 or higher) - TypeScript (v5.8 or higher, included in dependencies) 3. Build the project: This compiles the TypeScript source files to JavaScript in the build directory.

README

원문 README의 일부입니다. 원문 보기.

Archy - Architectural Diagram Builder

Features

Generate diagrams from text descriptions
Generate diagrams from GitHub repositories
Support for all Mermaid diagram types:
- Flowcharts
- Sequence Diagrams
- Class Diagrams
- State Diagrams
- Entity Relationship Diagrams
- User Journeys
- Gantt Charts
- Pie Charts
- Quadrant Charts
- Requirement Diagrams
- Git Graphs
- C4 Diagrams

Installation

Prerequisites

Node.js (v16 or higher)
npm (v7 or higher)
TypeScript (v5.8 or higher, included in dependencies)

Install from Source

Clone the repository:

git clone https://github.com/phxdev1/archy.git
cd archy

Install dependencies:
```
npm install
```
Build the project:
```
npm run build
```
This compiles the TypeScript source files to JavaScript in the build directory.

Automated MCP Installation

Archy includes a convenient installation script that automatically configures the MCP server for both VS Code and Claude:

npm run install-mcp

This script:

Automatically detects the correct MCP settings locations for your operating system
Updates the MCP configuration files for VS Code and Claude
Prompts for a GitHub token for repository analysis (optional)
Makes the server executable

No need to manually edit JSON configuration files like some kind of cave-dwelling animal! The script handles all the tedious configuration work for you, so you can focus on creating beautiful diagrams instead of wrestling with file paths and permissions.

Configuration

Archy can be configured using environment variables:

GITHUB_TOKEN: GitHub API token for authenticated requests (optional)
OPENROUTER_API_KEY: OpenRouter API key for AI-powered diagram generation (optional)

OpenRouter Integration

Archy includes integration with OpenRouter through LangChain, enabling enhanced AI-powered diagram generation. When an OpenRouter API key is configured, additional tools become available:

AI-Enhanced Text-to-Diagram Generation: Generate more sophisticated diagrams from text descriptions
Code-to-Diagram Generation: Analyze code and generate appropriate diagrams
Diff Visualization: Generate diagrams showing differences between code versions

To use these features:

Sign up for an account at OpenRouter
Get your API key from the OpenRouter dashboard

GitHub에서 전체 README 보기

설치

npx tsc

MCP 초보자라면? mcpskill.org 가이드부터 시작하세요 →

설정

{
  "mcpServers": {
    "archy": {
      "command": "node",
      "args": ["/path/to/archy/build/index.js"],
      "env": {
        "GITHUB_TOKEN": "your-github-token"
      }
    }
  }
}