Skip to content
SpartanAuth SpartanAuth Docs

AI Coding Skills

SpartanAuth ships an AI skills package — a set of context files that give your AI coding agent everything it needs to implement a SpartanAuth integration correctly, without you having to paste docs into a chat.

AGENTS.md

Universal format. Works with GitHub Copilot, Windsurf, OpenAI Codex, Cline, Aider, and more — just drop it at your project root.

⬇ Download AGENTS.md

Cursor Rules (.mdc)

Cursor-specific format with alwaysApply: true. Copy into .cursor/rules/ and Cursor picks it up automatically.

⬇ Download spartanauth.mdc

Quickest path: one command

Section titled “Quickest path: one command”

Copy AGENTS.md directly into your project root:

Terminal window
curl -o AGENTS.md https://docs.spartanauth.com/skills/AGENTS.md

Or with wget:

Terminal window
wget -O AGENTS.md https://docs.spartanauth.com/skills/AGENTS.md

What’s in the skills file?

Section titled “What’s in the skills file?”

The AGENTS.md file contains everything your agent needs, formatted as a compact context document optimized for LLM consumption:

  • Widget attributes and event API (<spartan-login>, <spartan-account-settings>)
  • Framework integration patterns (Vue 3, React, Vanilla JS)
  • Backend token introspection code (Go example + generic patterns)
  • The fetch wrapper and 401 handling patterns
  • Common mistakes and how to avoid them
  • Reactivity gotchas specific to web components in SPA frameworks

It’s the same content as this documentation, but structured for AI agent consumption rather than human reading.

Setup by agent

Section titled “Setup by agent”

Auto-loaded (no extra steps)

Section titled “Auto-loaded (no extra steps)”

Place AGENTS.md at your project root — these agents load it automatically:

| Agent | What to do | |---|---| | GitHub Copilot (agent mode) | Place AGENTS.md at project root | | Windsurf | Place AGENTS.md at project root | | OpenAI Codex CLI | Place AGENTS.md at project root | | Cline | Place AGENTS.md at project root |

Requires one extra step

Section titled “Requires one extra step”

Claude Code

Place AGENTS.md at your project root, then create or update CLAUDE.md to reference it:

# My Project


@AGENTS.md

Gemini CLI

Place AGENTS.md at your project root, then create .gemini/settings.json:

{
  "context": {
    "fileName": ["AGENTS.md", "GEMINI.md"]
  }
}

Cursor

Cursor doesn’t natively read AGENTS.md. Use the pre-built .mdc file instead:

Terminal window
mkdir -p .cursor/rules
curl -o .cursor/rules/spartanauth.mdc https://docs.spartanauth.com/skills/cursor-rules/spartanauth.mdc

Or copy the content of AGENTS.md into .cursor/rules/spartanauth.mdc with this frontmatter at the top:

---
description: SpartanAuth login widget integration patterns and backend token verification
alwaysApply: true
---

Aider

Place AGENTS.md at your project root, then create .aider.conf.yml:

read: AGENTS.md

Any other agent

Section titled “Any other agent”

Attach AGENTS.md directly in your chat session, or paste its contents as context when starting a conversation about authentication implementation.

Keeping the file up to date

Section titled “Keeping the file up to date”

When SpartanAuth releases updates to the widget API or integration patterns, a new version of AGENTS.md is published at the same URL. Re-run the curl command above to update, or re-download from the links at the top of this page.