Skip to main content

Plugin-based FRC documentation agent as an MCP server for WPILib and vendor libraries

Project description

FIRST Agentic CSA

A helpful tool for FIRST Robotics Competition teams! This lets you search through all your FRC documentation (WPILib, REV, CTRE, and more) using simple questions. Instead of clicking through dozens of web pages, just ask a question and get the answer you need.

What Does This Do?

Have you ever spent hours looking for how to configure a SparkMax motor controller? Or trying to find the right way to use a PID controller? This tool helps you find answers fast by searching through all the FRC documentation at once.

Features

  • One Search for Everything: Search WPILib, REV, CTRE, Redux, and PhotonVision docs all at once
  • Ask in Plain English: Type questions like "How do I configure a SparkMax?" instead of searching through menus
  • Filter by Language: Get results for Java, Python, or C++ (whichever you're using)
  • Works with Any Year: Search 2024 docs, 2025 docs, or whatever version you need
  • Works in VS Code: Set it up once and use it right in your coding environment

Installation for VS Code

  1. Open VS Code
  2. Press Ctrl+Shift+P (or Cmd+Shift+P on Mac) to open the command palette
  3. Type "MCP: Add Server" and select it
  4. Choose "Pip package" from the options
  5. When prompted, enter: first-agentic-csa
  6. VS Code will automatically install and configure everything for you!

Setting Up GitHub Copilot

To get the best experience with AI coding assistants (like GitHub Copilot or Cursor), add the copilot-instructions.md file to your FRC project. This tells the AI to always search the documentation before answering FRC questions.

  1. Copy the copilot-instructions.md file from this repository
  2. Paste it into the root folder of your FRC robot project
  3. The AI assistant will automatically use it to provide better, documentation-backed answers!

That's it! Now you can ask questions about FRC documentation right in VS Code, and your AI assistant will automatically search the docs for accurate answers.

Quick Start

Once installed, you can search for documentation by asking questions like:

  • "How do I configure a SparkMax motor controller?"
  • "What's the best way to use PID control?"
  • "Show me examples of command-based programming"

The tool will search through all the FRC documentation and give you the most relevant results.

What Documentation Can I Search?

This tool searches through documentation from:

  • WPILib - The main FRC programming library (docs.wpilib.org)
  • REV Robotics - SparkMax and other REV products (docs.revrobotics.com)
  • CTRE Phoenix - TalonFX and other CTRE products (v6.docs.ctr-electronics.com)
  • Redux Robotics - Redux products (docs.reduxrobotics.com)
  • PhotonVision - Computer vision library (docs.photonvision.org)

You can search all of them at once, or pick specific ones to search.

Customization (Optional)

If you want to change settings, you can edit the config.json file. This is totally optional - the default settings work great for most teams.

You can:

  • Turn off certain documentation sources if you don't use them
  • Set your default programming language
  • Change how many results you get back

Most teams don't need to change anything - the defaults work well!

Troubleshooting

"Command not found" or Server won't start

Make sure you:

  1. Have Python 3.11 or newer installed
  2. Restarted VS Code after adding the server
  3. Checked that the MCP extension is installed and enabled

Still having issues?

  1. Open the command palette (Ctrl+Shift+P)
  2. Type "MCP: Remove Server" and select it
  3. Choose frc-docs (or whatever you named it)
  4. Then add it again following the installation steps above

Need Help?

If you're stuck or have questions:

  1. Make sure you restarted VS Code after adding the server
  2. Check the troubleshooting section above
  3. Verify that Python 3.11 or newer is installed and working

For Advanced Users

If you want to contribute to this project or add support for new documentation sources, check out the technical documentation in the codebase. The project is open source and welcomes contributions!

License

This project is open source and free to use. See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

first_agentic_csa-0.3.9.tar.gz (2.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

first_agentic_csa-0.3.9-py3-none-any.whl (690.7 kB view details)

Uploaded Python 3

File details

Details for the file first_agentic_csa-0.3.9.tar.gz.

File metadata

  • Download URL: first_agentic_csa-0.3.9.tar.gz
  • Upload date:
  • Size: 2.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.16 {"installer":{"name":"uv","version":"0.9.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for first_agentic_csa-0.3.9.tar.gz
Algorithm Hash digest
SHA256 d0e2a5bb4895d5bca9aed382a2c71370fee8db61d7f54944339a7a6109dc6fe6
MD5 825e6745fa416d67391a2c88e673215b
BLAKE2b-256 2370aa0222f42edc70f5bbdcc532069f831fbd8cf6c312672e5c5832226987d8

See more details on using hashes here.

File details

Details for the file first_agentic_csa-0.3.9-py3-none-any.whl.

File metadata

  • Download URL: first_agentic_csa-0.3.9-py3-none-any.whl
  • Upload date:
  • Size: 690.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.16 {"installer":{"name":"uv","version":"0.9.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for first_agentic_csa-0.3.9-py3-none-any.whl
Algorithm Hash digest
SHA256 b6574a59398bd30512fe5c7403be596b3ea8cdb9d9e93851ee4e03c9f41839f8
MD5 e840ae93a5dd203dedf39a7b32676019
BLAKE2b-256 7fd6222cce79c09f559c0e1159f9ddb211976a544faadfed0cf5026758437f95

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page