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 文件。