README
🚀 Grigori
Grigori 是一款桌面应用程序,用于管理编码上下文,AI 助手可通过 MCP(模型上下文协议)访问这些上下文。它能帮助你以结构化的方式定义和组织编码标准、架构模式以及开发偏好。
🚀 快速开始
前提条件
- .NET 10 SDK
- 支持 Windows、macOS 或 Linux(通过 MAUI)
构建与运行
# 克隆仓库
git clone https://github.com/andres-m-rodriguez/Grigori.git
cd Grigori
# 构建项目
dotnet build
# 运行桌面应用
dotnet run --project src/Grigori.Desktop
从 Claude Code 连接
将以下内容添加到你的 Claude Code MCP 设置中:
{
"mcpServers": {
"grigori": {
"url": "http://localhost:3001/sse"
}
}
}
✨ 主要特性
编码上下文
- 编码模式:记录你常用的编码模式(例如“仓库模式”“CQRS”)。
- 设计偏好:定义你的编码风格选择,并说明理由和优先级。
- 避免规则:指定要避免的模式和实践,并设置严重级别。
架构上下文
- 架构模式:使用 ASCII 图定义分层架构。
- 层依赖关系:指定层之间允许和禁止的依赖关系。
- 代码模板:带有占位符的可复用代码模板,用于搭建项目框架。
- 命名约定:记录不同上下文(如 DTO、仓库等)的命名模式。
MCP 集成
- 内置 MCP 服务器,提供 40 多种用于读写上下文的工具。
- 可从 Claude Code、Cursor 或任何兼容 MCP 的客户端进行连接。
- AI 助手在帮助你编码时可以查询你的编码标准。
📦 安装指南
按照上述“快速开始”部分的步骤进行安装和配置。
💻 使用示例
基础用法
# 克隆仓库
git clone https://github.com/andres-m-rodriguez/Grigori.git
cd Grigori
# 构建项目
dotnet build
# 运行桌面应用
dotnet run --project src/Grigori.Desktop
高级用法
在 Claude Code 中配置 MCP 连接:
{
"mcpServers": {
"grigori": {
"url": "http://localhost:3001/sse"
}
}
}
📚 详细文档
MCP 工具
编码上下文工具
| 工具 | 描述 |
|------|-------------|
| get_coding_context | 以 Markdown 格式获取完整的编码上下文 |
| get_coding_patterns | 以 JSON 格式获取所有编码模式 |
| get_design_preferences | 以 JSON 格式获取所有设计偏好 |
| get_avoidance_rules | 以 JSON 格式获取所有避免规则 |
| search_context | 在所有上下文中搜索关键字 |
| add_coding_pattern | 添加新的编码模式 |
| add_design_preference | 添加新的设计偏好 |
| add_avoidance_rule | 添加新的避免规则 |
架构上下文工具
| 工具 | 描述 |
|------|-------------|
| get_architecture_context | 以 Markdown 格式获取完整的架构上下文 |
| get_architecture_patterns | 获取所有架构模式 |
| get_active_architecture_pattern | 获取当前活动的模式 |
| add_architecture_pattern | 添加新的架构模式 |
| add_architecture_layer | 向模式中添加层 |
| add_layer_dependency | 定义允许/禁止的依赖关系 |
| get_code_templates | 获取所有代码模板 |
| add_code_template | 添加新的代码模板 |
| get_naming_conventions | 获取所有命名约定 |
| add_naming_convention | 添加新的命名约定 |
🔧 技术细节
项目结构
src/
├── Grigori.Desktop/ # MAUI Blazor Hybrid 桌面应用
│ ├── Components/ # Blazor 页面和组件
│ └── Mcp/ # MCP 服务器集成
├── Grigori.Contracts/ # DTO 和仓库接口
├── Grigori.DataAccess/ # 仓库实现
├── Grigori.Database/ # EF Core DbContext 和模型
└── Grigori.Common.Pagination/ # 基于游标分页
技术栈
- .NET 10:最新的 .NET 运行时。
- MAUI Blazor Hybrid:跨平台桌面 UI。
- MudBlazor:Material Design 组件库。
- SQLite:本地数据库存储。
- Entity Framework Core:ORM。
- MinimalMcp:MCP 服务器实现。
- BlazingSingularity:异步命令状态管理。
📄 许可证
本项目采用 MIT 许可证。
🔗 导出
设置页面包含导出功能,可从你的编码上下文中生成 CLAUDE.md 格式的文件,适用于不使用 MCP 的项目。
微信扫一扫