
phxdev1/archy-mcp
Developer toolsこのページは AI により自動翻訳されています。技術的な詳細は原文をご確認ください。 原文を見る
Archy は、MCP (Model Context Protocol) サーバーで、Mermaid の構文を使って建築図を生成します.
概要
Archy は、MCP (Model Context Protocol) サーバーで、Mermaid の構文を使って建築図を生成します。 自然言語の説明と GitHub リポジトリ URL の両方を処理し、さまざまな種類の図を作成できます。 - テキストの説明から図を生成します - GitHubリポジトリから図を生成 - すべてのマーメイドの図タイプのサポート: - フローチャート - シーケンス図 - クラス図 - 状態図 - エンゲージメント関係図 - ユーザージャーニー - ガントチャート - パイチャート - 象図 - 要件図 - ジットグラフ - C4図 - Node.js(v16以上) - npm(v7以上) - TypeScript(v5.8以上、依存関係に含まれています) 3。 プロジェクトをビルドする: これは、ビルドディレクトリの JavaScript に TypeScript ソースファイルをコンパイルします.
概要(AI 翻訳)
Archy は、MCP (Model Context Protocol) サーバーで、Mermaid の構文を使って建築図を生成します。 自然言語の説明と GitHub リポジトリ URL の両方を処理し、さまざまな種類の図を作成できます。
##特徴
- テキストの説明から図を生成する
- GitHubリポジトリから図を生成する
- すべての人魚図タイプのためのサポート:
- フローチャート
- シーケンス図
- クラス図
- 状態図
- エンティティ・リレーション・ダイアグラム
- ユーザージャーニー
- ガントチャート
- パイチャート
- クアドラントチャート
- 要件図
- Gitグラフ
- C4図
インストール
前提条件
- Node.js(v16以上)
- npm(v7以上)
- TypeScript(v5.8以上、依存関係に含まれている)
ソースからインストールする
-
リポジトリのクローン化:
-
依存関係を取付けて下さい:
-
プロジェクトのビルド:
TypeScript ソースファイルを build] ディレクトリの JavaScript にコンパイルします。
自動MCPインストール
Archy には、VS コードと Claude の両方で MCP サーバーを自動的に構成する便利なインストールスクリプトが含まれています。
このスクリプト:
- オペレーティングシステムの正しいMCP設定場所を自動的に検出します
このページは AI により自動翻訳されています。技術的な詳細は原文をご確認ください。
README
以下は原文 README の抜粋です。原文を見る。
Archy - Architectural Diagram Builder
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.
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 buildThis compiles the TypeScript source files to JavaScript in the
builddirectory.
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
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
インストール
npx tsc設定
{
"mcpServers": {
"archy": {
"command": "node",
"args": ["/path/to/archy/build/index.js"],
"env": {
"GITHUB_TOKEN": "your-github-token"
}
}
}
}