Hi-AI 使用说明
项目简介
Hi-AI 是一个强大的 AI 开发助手,它实现了 Model Context Protocol (MCP) 标准,使大型语言模型(LLM)客户端能够通过标准化协议调用各种开发工具。它支持 TypeScript 和 Python 项目分析,具备智能内存管理、上下文压缩、代码质量检查、项目规划和思维辅助等功能,旨在通过自动化和智能化提升开发者的工作效率。
主要功能点
- 智能内存管理: 基于 SQLite 数据库,管理会话上下文信息。支持自动保存、恢复、优先级排序和按类别搜索记忆,确保关键信息不会丢失。
- 代码分析: 提供针对 TypeScript、JavaScript 和 Python 代码的深度分析能力。功能包括查找符号定义、追踪代码引用、评估代码复杂度、验证代码质量、检查耦合与内聚等,帮助开发者理解和优化代码。
- 项目规划: 辅助产品经理和开发者进行项目前期规划。能够自动生成产品需求文档 (PRD)、创建详细的用户故事以及构建全面的开发路线图。
- 思维辅助: 提供结构化的思考工具,帮助解决复杂问题。包括问题分解、循序渐进分析、创建思维链和将任意内容格式化为清晰的计划等。
- Prompt 工程: 分析并优化与 AI 交互的 Prompt(提示词)质量,提升其清晰度、具体性和上下文相关性。
- 浏览器自动化: 集成 Puppeteer-core,提供浏览器控制台日志监控和网络请求检查功能,便于网页应用调试和性能分析。
- UI 预览: 在实际编码之前,通过 ASCII 艺术形式快速预览 UI 布局和组件结构,支持多种常见布局类型。
- 时间工具: 提供查询当前时间的实用功能,支持多种时间格式和时区。
安装步骤
-
系统要求:
- 确保已安装 Node.js 18.0 或更高版本。
- 确保已安装 TypeScript 5.0 或更高版本。
- 如果需要进行 Python 代码分析,请确保系统已安装 Python 3.x。
- 对于浏览器自动化工具(如监控控制台日志、检查网络请求),您的系统需要安装 Chrome/Chromium 浏览器。如果没有,工具会尝试查找其他兼容浏览器(如 Edge, Brave)。
-
通过 npm 安装 (推荐全局安装): 在您的终端中运行以下命令:
npm install -g @su-record/hi-ai全局安装后,'hi-ai' 命令将在您系统的任何路径下可用。
服务器配置 (用于 MCP 客户端)
您需要将 Hi-AI 服务器配置到您的 MCP 客户端中,以便客户端能够发现并调用 Hi-AI 提供的工具。以下是一个示例 JSON 配置,请根据您的 MCP 客户端类型进行调整:
{ "mcpServers": { "hi-ai": { // 服务器的唯一名称,您可以自定义 "command": "hi-ai", // 启动 Hi-AI 服务器的命令。如果您是全局安装,直接使用 "hi-ai" "args": [], // 启动参数,当前版本不需要额外参数 "env": {} // 环境变量,如果您的服务器需要特定的环境变量,可以在这里配置 } } }
请注意,'hi-ai' 是服务器的默认名称,但您可以根据需要更改。配置完成后,您的 MCP 客户端应该能识别并列出 Hi-AI 提供的所有工具。
基本使用方法
-
启动会话: 在您的 MCP 客户端中,通过输入自然语言触发 'start_session' 工具,例如:
- "hi-ai"
- "hello"
- "你好,AI 助手" 这将启动一个新会话,并根据配置加载最近的项目信息和编码指南。
-
调用工具: 通过自然语言向您的 MCP 客户端描述您想完成的任务。Hi-AI 会根据您的输入,自动匹配并调用最合适的工具,并返回处理结果。
- 记忆信息:
- "记住这个重要的项目决策:我们需要在下周前完成用户认证模块。" (调用 'save_memory' 工具)
- "我保存了什么信息?" (调用 'list_memories' 工具)
- 代码分析:
- "找出 'src/utils.ts' 文件中 'formatDate' 函数的所有引用。" (调用 'find_references' 工具)
- "分析这段 TypeScript 代码的复杂度:'function calculateSum(a: number, b: number) { return a + b; }'。" (调用 'analyze_complexity' 工具)
- 项目规划:
- "生成一个关于开发新社交媒体应用的产品需求文档。" (调用 'generate_prd' 工具)
- "为用户管理、帖子发布和评论功能创建用户故事。" (调用 'create_user_stories' 工具)
- 思维辅助:
- "请帮我逐步分析如何解决用户登录失败的问题。" (调用 'step_by_step_analysis' 工具)
- "将我刚才提到的任务整理成一个带有时间预估和优先级的计划。" (调用 'format_as_plan' 工具)
- 浏览器调试:
- "监控 'https://example.com' 的控制台日志,持续 20 秒。" (调用 'monitor_console_logs' 工具)
- "检查 'https://api.example.com/users' 的网络请求。" (调用 'inspect_network_requests' 工具)
- 记忆信息:
-
获取帮助: 如果您不确定某个工具的名称或用法,可以尝试向客户端提问,例如 "有哪些代码分析工具可用?",让客户端帮助您找到并列出相关工具。
信息
分类
开发者工具