使用说明
用于游标的ABP插件
ABP Cursor开发工具包——框架规则、最佳实践和通过MCP集成ABP Studio。
包含什么
规则
此插件捆绑 16条精心策划的规则 教Cursor如何编写地道的ABP框架代码。规则会根据您正在处理的文件自动激活。
| 规则 | 描述 |
|---|---|
| abp核心 | 核心ABP框架约定——模块系统、依赖注入和基类 |
| 应用层 | 应用程序服务、DTO、验证和错误处理模式 |
| 授权 | 权限系统和授权模式 |
| cli命令 | ABP CLI命令： generate-proxy, install-libs, add-package-ref, new-module, install-module, update, clean, suite generate |
| ddd模式 | DDD模式——实体、聚合根、存储库、域服务 |
| 依赖性规则 | 层依赖规则和项目结构护栏 |
| 开发流程 | 开发工作流程——添加功能、实体和迁移 |
| ef核心 | 实体框架核心模式——_DE、迁移、存储库 |
| 基础设施 | 基础架构服务--设置、功能、缓存、事件、后台作业 |
| MongoDB | MongoDB模式——Mongo_和存储库 |
| 多租户 | 多租户模式——租户感知实体、数据隔离和租户切换 |
| 解决方案模板 | 解决方案模板结构——检测并遵循正确的模板模式（应用、应用多层、模块、微服务） |
| 测试模式 | 测试模式——单元测试和集成测试 |
| ui角度 | Angular UI模式和最佳实践 |
| ui blazor | DateTimeUI模式和组件 |
| ui mvc | MVC和Razor页面UI模式 |
ABP Studio MCP服务器
此插件包括 主控程序 将Cursor连接到本地ABP Studio实例的服务器配置。ABP Studio通过模型上下文协议公开运行时遥测和解决方案控制工具。请参阅 ABP Studio MCP文档 了解更多详情。
先决条件： MCP使用时，ABP Studio必须正在运行。这 abp 必须在PATH中安装CLI并使其可用。如果安装了ABP Studio桌面应用程序，则默认情况下CLI已安装并添加到PATH中。
可用的MCP工具
监控
| 工具 | 说明 |
|---|---|
list_applications |
列出连接到ABP Studio的所有正在运行的ABP应用程序 |
get_exceptions |
获取最近的异常，包括堆栈跟踪和错误消息 |
get_logs |
获取日志条目（可以按日志级别筛选） |
get_requests |
获取HTTP请求信息（可按状态代码筛选） |
get_events |
获取用于调试服务间通信的分布式事件 |
clear_monitor |
清除收集的监视器数据 |
应用程序控制
| 工具 | 说明 |
|---|---|
list_runnable_applications |
列出当前运行配置文件中的所有应用程序及其状态 |
start_application |
启动已停止的应用程序 |
stop_application |
停止正在运行的应用程序 |
restart_application |
重新启动正在运行的应用程序 |
build_application |
构建一个。NET应用程序使用 dotnet build |
容器控件
| 工具 | 说明 |
|---|---|
list_containers |
列出当前运行配置文件中的Docker容器及其状态 |
start_containers |
启动Docker容器（Docker compose up） |
stop_containers |
停止Docker容器（Docker编写关闭） |
解决方案结构
| 工具 | 说明 |
|---|---|
get_solution_info |
获取解决方案名称、路径、模板和运行配置文件信息 |
list_modules |
列出解决方案中的所有模块 |
list_packages |
列出解决方案中的包（项目）（可按模块筛选） |
get_module_dependencies |
获取模块依赖关系/导入信息 |
用法
在Cursor中安装插件后：
- 规则 在编写、审阅或重构ABP Framework代码时自动激活。它们提供了DDD模式、模块架构、授权、UI层、测试等方面的指导。
- ABP Studio MCP工具 让您直接从Cursor与正在运行的应用程序进行交互：
- “显示我的应用程序中最近的例外情况”
- “列出所有正在运行的应用程序”
- “重新启动Web应用程序”
- “获取具有警告级别的最新日志”
- “此解决方案中包含哪些模块？”
MCP服务器的工作原理
ABP Studio在后台运行本地MCP服务器。这 abp mcp-studio CLI命令充当Cursor连接到的stdio网桥。该网桥将请求转发到ABP Studio并返回响应。
Cursor ──stdio──▶ abp mcp-studio ──HTTP──▶ ABP Studio
监控数据（异常、日志、请求、事件）保存在内存中，并在解决方案关闭时清除。
目录结构
cursor-abp-plugin/
├── .cursor-plugin/
│ └── plugin.json # Plugin manifest
├── .mcp.json # MCP server configuration
├── assets/
│ └── abp-icon.svg # Plugin logo
├── rules/ # All rules as .mdc files
│ ├── abp-core.mdc
│ ├── application-layer.mdc
│ ├── authorization.mdc
│ ├── cli-commands.mdc
│ ├── ddd-patterns.mdc
│ ├── dependency-rules.mdc
│ ├── development-flow.mdc
│ ├── ef-core.mdc
│ ├── infrastructure.mdc
│ ├── mongodb.mdc
│ ├── multi-tenancy.mdc
│ ├── solution-templates.mdc
│ ├── testing-patterns.mdc
│ ├── ui-angular.mdc
│ ├── ui-blazor.mdc
│ └── ui-mvc.mdc
└── README.md # This file
