ProjGraph MCP Server

ProjGraph 是一个用于可视化项目依赖关系、数据库架构和类层次结构的 .NET 工具生态系统。 它既提供用于手动分析的命令行工具，也提供用于借助 AI 探索代码库架构的 MCP 服务。

🚀 快速开始

CLI 工具

安装并使用命令行工具，即可快速生成可视化结果：

# Install
dotnet tool install -g ProjGraph.Cli

# Visualize project dependencies
projgraph visualize ./MySolution.slnx

# Generate Entity Relationship Diagram (from DbContext or ModelSnapshot)
projgraph erd ./Data/MyDbContext.cs

# Generate Class Diagram for a class and its hierarchy
projgraph classdiagram ./Models/User.cs

# Compute key solution metrics (project counts, depth, hotspots)
projgraph stats ./MySolution.slnx

📖 CLI 完整文档

MCP 服务

使用以下设置配置 MCP 客户端（例如 GitHub Copilot、Claude）：

在 NuGet 上查找最新版本号

{
  "servers": {
    "ProjGraph.Mcp": {
      "type": "stdio",
      "command": "dnx",
      "args": ["[email protected]", "--yes"]
    }
  }
}

📖 MCP 完整文档

✨ 主要功能

• 📊 多种输出格式：ASCII 树和 Mermaid.js 图表
• 🗄️ 实体关系图：从 EF Core DbContext 或 ModelSnapshot 文件生成 ERD
• 🏗️ 类层次结构：可视化类图，展示继承关系和依赖关系
• 📈 解决方案指标：项目数量、类型分布、依赖深度和热点检测
• 📁 支持现代 .NET：全面支持 .slnx、.sln 和 .csproj 文件
• 🤖 AI 集成：为 GitHub Copilot、Claude 和其他 AI 助手提供 MCP 服务
• ⚡ 快速可靠：高效的解析和图算法

🛠️ 开发

前置条件

• .NET 10.0 SDK 或更高版本

本地运行

# CLI
dotnet run --project src/ProjGraph.Cli -- visualize ./ProjGraph.slnx

# Stats
dotnet run --project src/ProjGraph.Cli -- stats ./ProjGraph.slnx

# MCP Server
dotnet run --project src/ProjGraph.Mcp

📝 使用示例

分析项目依赖关系

# Mermaid format (default)
projgraph visualize ./MySolution.sln

# ASCII tree format
projgraph visualize ./MySolution.sln --format tree

# Mermaid format for documentation
projgraph visualize ./MySolution.slnx --format mermaid --output docs/dependencies.mmd

生成数据库图表

# Generate ERD from DbContext
projgraph erd ./Data/MyDbContext.cs

# Generate ERD from ModelSnapshot (leveraging migrations)
projgraph erd ./Migrations/MyDbContextModelSnapshot.cs

# Output to Markdown for documentation
projgraph erd ./Data/MyDbContext.cs --output docs/database-schema.md

# Control how EF Core owned types (OwnsOne/OwnsMany) are rendered:
# 'mirror' (default) inlines a table-split owned type onto its owner as EF names it;
# 'classic' gives every owned type its own entity box regardless of table mapping
projgraph erd ./Data/MyDbContext.cs --owned-mode classic

可视化类层次结构

# Generate diagram for a class and its inheritance and dependencies
projgraph classdiagram ./Models/Admin.cs -i -d

# Control discovery depth (default: 1)
projgraph classdiagram ./Models/Admin.cs -i -d --depth 5

分析解决方案指标

# Display project counts, depth stats, and hotspot projects
projgraph stats ./MySolution.slnx

# Show top 10 most-referenced projects
projgraph stats ./MySolution.slnx --top 10

使用 AI 助手

配置 MCP 服务后：

You: "Analyze the dependencies in my solution"
AI: [Generate the architecture diagram]

You: "Generate a class diagram for the User class"
AI: [Generates the class hierarchy]

You: "Show me the entity relationships in my DbContext"
AI: [Generates the database schema]

You: "Give me a health summary of my solution"
AI: [Returns project counts, depth stats, and hotspot projects]

🔗 链接

• CLI 包：NuGet 上的 ProjGraph.Cli
• MCP 包：NuGet 上的 ProjGraph.Mcp

📚 示例与展示

在 示例展示 中查看 ProjGraph 功能的实际示例。 示例包括：

• 电子商务 ERD：具有继承关系和层次结构的复杂数据库模型。
• 设计模式：展示模式实现的深层类图。
• 模块化架构：现代解决方案的项目依赖关系可视化。
• 简单层次结构：适合新用户的入门级示例。
• 解决方案指标：汇总项目数量、依赖深度和热点的架构健康状况。

📚 文档

• 架构概览 - 解决方案结构和设计决策
• 贡献指南 - 如何为项目做出贡献
• 安全策略 - 安全问题报告指南