agentic-csa

🚀 FIRST Agentic CSA

FIRST Agentic CSA 是一款专为 FIRST 机器人竞赛团队打造的实用工具！它能让你通过简单的问题，搜索所有 FRC 文档（包括 WPILib、REV、CTRE 等）。无需在数十个网页间点击查找，只需提出问题，就能获取所需答案。

🚀 快速开始

安装完成后，你可以通过提出类似以下的问题来搜索文档：

• “如何配置 SparkMax 电机控制器？”
• “使用 PID 控制的最佳方法是什么？”
• “给我展示基于命令的编程示例”

该工具会搜索所有 FRC 文档，并为你提供最相关的结果。

✨ 主要特性

• 一站式搜索：可同时搜索 WPILib、REV、CTRE、Redux 和 PhotonVision 等文档。
• 自然语言提问：你可以像这样提问 “如何配置 SparkMax？”，而无需在菜单中搜索。
• 语言过滤：可根据你使用的 Java、Python 或 C++ 语言获取相应结果。
• 多版本支持：能搜索 2024 年、2025 年等任意版本的文档。
• VS Code 集成：只需设置一次，即可在编码环境中直接使用。

📦 安装指南

VS Code 安装步骤

1. 打开 VS Code。
2. 按下 Ctrl+Shift+P（Mac 系统按 Cmd+Shift+P）打开命令面板。
3. 输入 “MCP: Add Server” 并选择。
4. 从选项中选择 “Pip package”。
5. 当提示输入时，输入：first-agentic-csa。
6. VS Code 将自动为你完成安装和配置！

GitHub Copilot 设置

为了在使用 AI 编码助手（如 GitHub Copilot 或 Cursor）时获得最佳体验，请将 copilot-instructions.md 文件添加到你的 FRC 项目中。这将告知 AI 在回答 FRC 问题前先搜索文档。

1. 如果你的仓库中 .github 目录不存在 copilot-instructions.md 文件，请从本仓库复制该文件到该目录。
2. AI 助手将自动使用该文件，以提供更准确、有文档支持的答案！

现在，你可以在 VS Code 中直接询问有关 FRC 文档的问题，AI 助手将自动搜索文档以获取准确答案。

📚 详细文档

可搜索的文档来源

该工具可搜索以下来源的文档：

• WPILib - 主要的 FRC 编程库（docs.wpilib.org）
• REV Robotics - SparkMax 等 REV 产品（docs.revrobotics.com）
• CTRE Phoenix - TalonFX 等 CTRE 产品（v6.docs.ctr-electronics.com）
• Redux Robotics - Redux 产品（docs.reduxrobotics.com）
• PhotonVision - 计算机视觉库（docs.photonvision.org）

你可以同时搜索所有文档，也可以选择特定的文档进行搜索。

自定义设置（可选）

如果你想更改设置，可以编辑 config.json 文件。这是完全可选的，默认设置对大多数团队来说效果很好。 你可以：

• 关闭不使用的文档源。
• 设置默认编程语言。
• 更改返回的结果数量。

大多数团队无需更改任何设置，默认设置就很适用！

故障排除

“Command not found” 或服务器无法启动

请确保：

1. 已安装 Python 3.11 或更高版本。
2. 添加服务器后重启了 VS Code。
3. 检查 MCP 扩展是否已安装并启用。

仍然存在问题？

1. 打开命令面板（Ctrl+Shift+P）。
2. 输入 “MCP: Remove Server” 并选择。
3. 选择 frc-docs（或你为其命名的名称）。
4. 然后按照上述安装步骤重新添加。

需要帮助？

如果你遇到困难或有疑问：

1. 确保添加服务器后重启了 VS Code。
2. 查看上述故障排除部分。
3. 验证是否已安装并正常运行 Python 3.11 或更高版本。

高级用户

如果你想为该项目做出贡献或添加对新文档源的支持，请查看代码库中的技术文档。该项目是开源的，欢迎贡献！

📄 许可证

本项目是开源的，可免费使用。详情请参阅 LICENSE 文件。