IDE架构蓝图系统

Abside是一个模块化的MCP(模型上下文协议)生态系统,帮助开发者和大型语言模型应用设计模式并编写更好的代码。

  • by CalettiGabriele
  • Python
  • 本地部署
  • 3 星标
  • 更新于
在 GitHub 查看 CalettiGabriele/Abside

使用说明

Abside

IDE架构蓝图系统

一个模块化的MCP(模型上下文协议)生态系统,帮助开发人员和LLM应用设计模式并编写更好的代码。


📋 目录

🎯 概述

Abside是MCP(模型上下文协议)服务器系列,旨在通过直接在IDE中提供智能架构指导、设计模式建议和代码质量改进来增强开发体验。

主要特点

  • 🏗️ 模块化架构:每台服务器都专注于软件开发的一个特定方面
  • 🔌 MCP协议:与AI驱动的IDE和工具无缝集成
  • 📚 图案库:全面收集设计模式和最佳实践
  • 🤖 人工智能原生:专为LLM辅助开发工作流程而构建
  • 🔧 可扩展:易于添加新的服务器和功能

🏛️ 建筑

Abside遵循微服务启发的架构,其中每个MCP服务器都是一个独立的专用组件:

┌─────────────────────────────────────────────────────────┐
│                      IDE / Client                        │
└─────────────────────────────────────────────────────────┘
                           │
                           │ MCP Protocol
                           │
        ┌──────────────────┼──────────────────┐
        │                  │                  │
┌───────▼────────┐ ┌──────▼───────┐ ┌───────▼────────┐
│  Pattern       │ │  Architecture │ │   Quality      │
│  Server        │ │  Server       │ │   Server       │
└────────────────┘ └──────────────┘ └────────────────┘
        │                  │                  │
        └──────────────────┴──────────────────┘
                           │
                    Shared Libraries

🖥️ MCP服务器

可用服务器

服务器 描述 状态
模式服务器 设计模式、SOLID原则、架构模式 🚧 发展中
架构服务器 系统设计、组件关系、依赖性分析 📋 计划中
质量服务器 代码质量指标、重构建议、最佳实践 📋 计划中
文档服务器 自动文档、API规范、内联注释 📋 计划中

服务器功能

每个MCP服务器提供:

  • 资源:访问模式库、文档和知识库
  • 工具:用于代码分析和转换的可执行函数
  • 提示词:常见开发任务的预配置提示

📦 安装

先决条件

  • Python 3.8或更高版本
  • pip或uv包管理器
  • 兼容MCP的IDE或客户端

从源代码安装

# Clone the repository
git clone https://github.com/CalettiGabriele/Abside.git
cd Abside

# Create a virtual environment
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install dependencies
pip install -e .

使用uv进行安装

uv pip install -e .

🚀 快速开始

1.配置IDE

将Abside服务器添加到MCP客户端配置中(例如。, claude_desktop_config.json):

{
  "mcpServers": {
    "abside-pattern": {
      "command": "python",
      "args": ["-m", "abside.servers.pattern"],
      "cwd": "/path/to/Abside"
    }
  }
}

2.开始使用Abside

配置后,您可以通过AI助手与Abside交互:

"Show me the Singleton pattern implementation"
"Analyze this code for SOLID principle violations"
"Suggest an architectural pattern for this microservice"

⚙️ 配置

每个服务器都可以通过环境变量或配置文件进行配置:

# .env file
ABSIDE_PATTERN_LIBRARY_PATH=/path/to/patterns
ABSIDE_LOG_LEVEL=INFO
ABSIDE_CACHE_ENABLED=true

有关具体的配置选项,请参阅单个服务器文档。

🛠️ 发展

项目结构

Abside/
├── src/
│   └── abside/
│       ├── servers/          # Individual MCP servers
│       │   ├── pattern/
│       │   ├── architecture/
│       │   └── quality/
│       ├── common/           # Shared utilities
│       └── patterns/         # Pattern library
├── tests/                    # Test suite
├── docs/                     # Documentation
├── examples/                 # Usage examples
└── README.md

运行测试

# Run all tests
pytest

# Run with coverage
pytest --cov=abside --cov-report=html

添加新服务器

  1. 在下创建新目录 src/abside/servers/
  2. 实现MCP服务器接口
  3. 添加服务器配置
  4. 编写测试
  5. 更新文档

看 贡献.md 详细指南。

🤝 贡献

欢迎投稿!请阅读我们的 贡献指南 在提交PR之前。

开发环境设置

# Install development dependencies
pip install -e ".[dev]"

# Install pre-commit hooks
pre-commit install

# Run linting
ruff check .

# Format code
ruff format .

📄 许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。

🙏 致谢

📞 联系