gtplanner

GTPlanner - AI PRD 生成工具

GTPlanner 是一个 AI 驱动的项目规划工具，可以将用户需求转换为专业的项目规划和技术架构文档。

快速开始

环境检查

首先确认 GTPlanner 环境已正确配置：

cd "${CLAUDE_PLUGIN_ROOT}"
uv run python -c "from agent.function_calling.agent_tools import get_agent_function_definitions; print('GTPlanner 环境正常')"

基本用法

GTPlanner 提供四个核心工具，通过 Python API 调用：

工具	功能	阶段
short_planning	需求分析与规划	范围确认
tool_recommend	技术栈推荐	技术实现
research	深度技术调研	技术实现(可选)
design	生成设计文档	文档生成

工作流程

标准工作流（推荐）

1. short_planning (initial)   → 初始需求分析
2. tool_recommend             → 技术栈推荐
3. short_planning (technical) → 技术规划整合
4. research (可选)            → 深度技术调研
5. design (quick/deep)        → 生成设计文档

简化工作流（简单项目）

1. short_planning (initial)   → 需求分析
2. design (quick)             → 快速生成文档

工具详解

1. short_planning - 短期规划

定义和细化项目范围，支持两个阶段：

参数：

• user_requirements (string, 必需): 用户的原始需求描述
• improvement_points (array): 需要改进的点或新需求
• planning_stage (string): initial 或 technical

调用示例：

# 初始规划阶段
result = await execute_agent_tool(
    'short_planning',
    {
        'user_requirements': '设计一个博客系统',
        'planning_stage': 'initial'
    },
    shared
)

# 技术规划阶段（在 tool_recommend 之后）
result = await execute_agent_tool(
    'short_planning',
    {
        'user_requirements': '设计一个博客系统',
        'planning_stage': 'technical'
    },
    shared
)

2. tool_recommend - 工具推荐

基于项目需求推荐平台支持的 API 或库。

参数：

• query (string, 必需): 查询文本，描述需要的工具功能
• top_k (integer): 返回数量，默认 5
• tool_types (array): 过滤类型 ["PYTHON_PACKAGE", "APIS"]
• use_llm_filter (boolean): 是否使用 LLM 筛选，默认 true

调用示例：

result = await execute_agent_tool(
    'tool_recommend',
    {
        'query': '博客系统需要的数据库和认证工具',
        'top_k': 5,
        'tool_types': ['PYTHON_PACKAGE', 'APIS']
    },
    shared
)

3. research - 技术调研（可选）

对推荐的技术栈进行深入可行性调研。

前置条件： 需要 JINA_API_KEY 环境变量

参数：

• keywords (array, 必需): 调研关键词列表
• focus_areas (array, 必需): 调研关注点
• project_context (string): 项目背景信息

调用示例：

result = await execute_agent_tool(
    'research',
    {
        'keywords': ['FastAPI', 'PostgreSQL', 'JWT认证'],
        'focus_areas': ['技术选型', '性能优化', '最佳实践'],
        'project_context': '博客系统后端开发'
    },
    shared
)

4. design - 架构设计

生成最终的系统架构方案和设计文档。