refactor: 完成PromptX资源架构重构和工具系统集成
- 将prompt/目录重构为resource/目录，统一资源管理 - 删除DACP相关代码，聚焦核心PromptX功能 - 新增鲁班角色，支持工具开发工作流 - 优化无面角色，增强学习和内容保存能力 - 修复角色加载和激活机制 - 完善MCP工具定义和适配器 - 清理过时的前端开发者等角色资源 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
sean
@ -0,0 +1,346 @@
|
||||
<execution>
|
||||
|
||||
<constraint>
|
||||
## 技术架构约束
|
||||
- **单文件工具**：每个工具必须是独立的.tool.js文件
|
||||
- **ToolInterface规范**：必须实现execute()、getDependencies()、getMetadata()等标准接口
|
||||
- **ToolSandbox兼容**：工具必须能在沙箱环境中正常运行
|
||||
- **协议统一**：通过@tool://协议访问，沙箱位于@user://.promptx/toolbox/
|
||||
- **依赖隔离**：每个工具的依赖安装在独立的沙箱目录中
|
||||
</constraint>
|
||||
|
||||
<rule>
|
||||
## 开发强制规则
|
||||
- **接口完整性**：必须实现所有必要的接口方法
|
||||
- **依赖声明**：所有外部依赖必须在getDependencies()中明确声明
|
||||
- **参数验证**：必须实现validate()方法验证输入参数
|
||||
- **错误处理**：必须有完善的异常处理机制
|
||||
- **安全第一**：禁止执行危险操作，确保沙箱安全
|
||||
</rule>
|
||||
|
||||
<guideline>
|
||||
## 开发指导原则
|
||||
- **用户体验优先**：接口设计简洁直观
|
||||
- **性能效率**：优化执行速度和资源使用
|
||||
- **可维护性**：代码结构清晰，注释完整
|
||||
- **渐进式功能**：先实现核心功能，再扩展高级特性
|
||||
- **测试驱动**：每个功能都要有相应的测试验证
|
||||
</guideline>
|
||||
|
||||
<process>
|
||||
## 🛠️ 标准工具开发流程
|
||||
|
||||
### Phase 1: 需求分析与设计 (15分钟)
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
A[用户需求] --> B[功能分析]
|
||||
B --> C[依赖调研]
|
||||
C --> D[接口设计]
|
||||
D --> E[原型验证]
|
||||
```
|
||||
|
||||
**Step 1.1: 深度需求分析**
|
||||
- 理解用户真实痛点
|
||||
- 分析现有解决方案的不足
|
||||
- 确定工具的核心价值主张
|
||||
- 明确功能边界和使用场景
|
||||
|
||||
**Step 1.2: 技术方案选择**
|
||||
- 选择合适的npm依赖包
|
||||
- 评估依赖包的稳定性和文档质量
|
||||
- 确认沙箱环境兼容性
|
||||
- 设计错误处理策略
|
||||
|
||||
**Step 1.3: 接口规范设计**
|
||||
```javascript
|
||||
// 标准工具接口模板
|
||||
module.exports = {
|
||||
getDependencies() {
|
||||
return ['package@version']; // 声明依赖
|
||||
},
|
||||
|
||||
getMetadata() {
|
||||
return {
|
||||
name: 'tool-name',
|
||||
description: '工具描述',
|
||||
version: '1.0.0',
|
||||
category: '分类'
|
||||
};
|
||||
},
|
||||
|
||||
getSchema() {
|
||||
return {
|
||||
type: 'object',
|
||||
properties: { /* JSON Schema */ }
|
||||
};
|
||||
},
|
||||
|
||||
validate(params) {
|
||||
// 参数验证逻辑
|
||||
},
|
||||
|
||||
async execute(params) {
|
||||
// 核心执行逻辑
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
### Phase 2: 核心实现 (30分钟)
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
A[创建工具文件] --> B[实现接口方法]
|
||||
B --> C[依赖管理]
|
||||
C --> D[核心逻辑]
|
||||
D --> E[错误处理]
|
||||
```
|
||||
|
||||
**Step 2.1: 工具文件创建**
|
||||
```bash
|
||||
# 标准文件路径
|
||||
.promptx/resource/tool/{tool-name}/{tool-name}.tool.js
|
||||
```
|
||||
|
||||
**Step 2.2: 依赖管理实现**
|
||||
```javascript
|
||||
getDependencies() {
|
||||
return [
|
||||
'lodash@^4.17.21', // 工具函数库
|
||||
'axios@^1.6.0', // HTTP请求
|
||||
'validator@^13.11.0' // 数据验证
|
||||
];
|
||||
}
|
||||
```
|
||||
|
||||
**Step 2.3: 元信息定义**
|
||||
```javascript
|
||||
getMetadata() {
|
||||
return {
|
||||
name: 'my-awesome-tool',
|
||||
description: '这是一个很棒的工具，用于...',
|
||||
version: '1.0.0',
|
||||
category: 'utility',
|
||||
author: '鲁班',
|
||||
tags: ['tool', 'automation', 'utility']
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
**Step 2.4: Schema定义**
|
||||
```javascript
|
||||
getSchema() {
|
||||
return {
|
||||
type: 'object',
|
||||
properties: {
|
||||
input: {
|
||||
type: 'string',
|
||||
description: '输入参数描述'
|
||||
},
|
||||
options: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
format: { type: 'string', default: 'json' }
|
||||
}
|
||||
}
|
||||
},
|
||||
required: ['input']
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
### Phase 3: 沙箱测试 (15分钟)
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
A[ToolSandbox创建] --> B[依赖安装]
|
||||
B --> C[功能测试]
|
||||
C --> D[边界测试]
|
||||
D --> E[性能测试]
|
||||
```
|
||||
|
||||
**Step 3.1: 沙箱环境验证**
|
||||
```javascript
|
||||
// 测试代码示例
|
||||
const ToolSandbox = require('./src/lib/tool/ToolSandbox');
|
||||
const ResourceManager = require('./src/lib/core/resource/resourceManager');
|
||||
|
||||
async function testTool() {
|
||||
const resourceManager = new ResourceManager();
|
||||
await resourceManager.initializeWithNewArchitecture();
|
||||
|
||||
const sandbox = new ToolSandbox('@tool://my-awesome-tool');
|
||||
sandbox.setResourceManager(resourceManager);
|
||||
|
||||
// 分析工具
|
||||
await sandbox.analyze();
|
||||
|
||||
// 准备依赖
|
||||
await sandbox.prepareDependencies();
|
||||
|
||||
// 测试执行
|
||||
const result = await sandbox.execute({
|
||||
input: 'test data',
|
||||
options: { format: 'json' }
|
||||
});
|
||||
|
||||
console.log('测试结果:', result);
|
||||
}
|
||||
```
|
||||
|
||||
**Step 3.2: 完整功能测试矩阵**
|
||||
- ✅ 正常参数测试
|
||||
- ✅ 边界值测试
|
||||
- ✅ 异常参数测试
|
||||
- ✅ 依赖缺失测试
|
||||
- ✅ 性能压力测试
|
||||
|
||||
### Phase 4: 优化与发布 (10分钟)
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
A[代码优化] --> B[文档完善]
|
||||
B --> C[注册表更新]
|
||||
C --> D[用户验收]
|
||||
```
|
||||
|
||||
**Step 4.1: 代码质量优化**
|
||||
- 重构冗余代码
|
||||
- 优化性能瓶颈
|
||||
- 完善错误信息
|
||||
- 添加调试日志
|
||||
|
||||
**Step 4.2: 注册表刷新与验证**
|
||||
|
||||
🔄 **刷新项目级资源注册表**
|
||||
|
||||
**在MCP环境中使用init工具**：
|
||||
- 使用MCP PromptX的`promptx_init`工具刷新项目级注册表
|
||||
- 该工具会重新扫描`.promptx/resource/`目录并更新资源注册表
|
||||
- 调用后工具立即可用，无需重启MCP服务器
|
||||
|
||||
**调用方式**：
|
||||
```
|
||||
工具名称: promptx_init
|
||||
参数: {"workingDirectory": "/current/project/path"}
|
||||
```
|
||||
|
||||
🔍 **验证工具注册成功**
|
||||
|
||||
**使用MCP工具验证**：
|
||||
- 使用`promptx_welcome`工具查看是否出现新工具
|
||||
- 使用`promptx_tool`工具测试新工具是否可用
|
||||
- 检查工具列表中是否包含新开发的工具
|
||||
|
||||
🚨 **注册表刷新关键时机**
|
||||
- ✅ 创建新工具后必须执行
|
||||
- ✅ 修改工具metadata后需要执行
|
||||
- ✅ MCP缓存问题时需要执行
|
||||
- ✅ 工具无法被发现时需要执行
|
||||
|
||||
💡 **PromptX注册表机制解释**
|
||||
- **项目级扫描**：`promptx init`重新扫描`.promptx/resource/`目录
|
||||
- **缓存重置**：清理ResourceManager缓存，重新发现资源
|
||||
- **MCP同步**：确保MCP服务器获取最新的工具列表
|
||||
|
||||
**Step 4.3: 用户接受度验证**
|
||||
- 接口易用性评估
|
||||
- 功能完整性确认
|
||||
- 性能表现验证
|
||||
- 安全性审查
|
||||
|
||||
## 🔧 高级开发技巧
|
||||
|
||||
### 依赖优化策略
|
||||
```javascript
|
||||
getDependencies() {
|
||||
// 按需声明，避免冗余
|
||||
const dependencies = [];
|
||||
|
||||
// 基础功能依赖
|
||||
if (this.needsUtilities()) {
|
||||
dependencies.push('lodash@^4.17.21');
|
||||
}
|
||||
|
||||
// 网络功能依赖
|
||||
if (this.needsHttp()) {
|
||||
dependencies.push('axios@^1.6.0');
|
||||
}
|
||||
|
||||
return dependencies;
|
||||
}
|
||||
```
|
||||
|
||||
### 智能错误处理
|
||||
```javascript
|
||||
async execute(params) {
|
||||
try {
|
||||
// 核心逻辑
|
||||
return await this.processData(params);
|
||||
} catch (error) {
|
||||
// 分类错误处理
|
||||
if (error.code === 'NETWORK_ERROR') {
|
||||
throw new Error('网络连接失败，请检查网络设置');
|
||||
} else if (error.code === 'VALIDATION_ERROR') {
|
||||
throw new Error(`参数验证失败: ${error.message}`);
|
||||
} else {
|
||||
throw new Error(`工具执行失败: ${error.message}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 性能优化模式
|
||||
```javascript
|
||||
async execute(params) {
|
||||
// 缓存机制
|
||||
const cacheKey = this.generateCacheKey(params);
|
||||
if (this.cache.has(cacheKey)) {
|
||||
return this.cache.get(cacheKey);
|
||||
}
|
||||
|
||||
// 执行逻辑
|
||||
const result = await this.processData(params);
|
||||
|
||||
// 缓存结果
|
||||
this.cache.set(cacheKey, result);
|
||||
return result;
|
||||
}
|
||||
```
|
||||
</process>
|
||||
|
||||
<criteria>
|
||||
## 工具质量评价标准
|
||||
|
||||
### 功能完整性 (25分)
|
||||
- ✅ 核心功能完全实现
|
||||
- ✅ 边界情况正确处理
|
||||
- ✅ 错误场景优雅降级
|
||||
- ✅ 用户需求完全满足
|
||||
|
||||
### 技术规范性 (25分)
|
||||
- ✅ ToolInterface完全符合
|
||||
- ✅ 依赖声明准确完整
|
||||
- ✅ Schema定义标准规范
|
||||
- ✅ 代码结构清晰可维护
|
||||
|
||||
### 沙箱兼容性 (25分)
|
||||
- ✅ ToolSandbox正常运行
|
||||
- ✅ 依赖自动安装成功
|
||||
- ✅ 资源隔离正确工作
|
||||
- ✅ 协议访问正常响应
|
||||
|
||||
### 用户体验质量 (25分)
|
||||
- ✅ 接口简洁易用
|
||||
- ✅ 错误信息友好
|
||||
- ✅ 性能表现优秀
|
||||
- ✅ 文档描述准确
|
||||
|
||||
### 卓越标准 (附加分)
|
||||
- 🌟 创新功能设计
|
||||
- 🌟 极致性能优化
|
||||
- 🌟 出色的错误处理
|
||||
- 🌟 完美的用户体验
|
||||
</criteria>
|
||||
|
||||
</execution>
|
||||
Reference in New Issue
Block a user