agentleFS
sumithrsumithr/sumo-qa/AGENTS.md

sumo-qa

AGENTS.md7 starsChanged 40 days agoApache-2.0View on GitHub

If you're an AI agent setting up sumo-qa for the user, follow this exactly. One command for the common case; per-host flags if you only need to wire one host. When creating GitHub issues, use the closest template in .github/ISSUE_TEMPLATE/ and include every required field in the issue body. For implementation tasks raised by an AI agent, use .github/ISSUE_TEMPLATE/ai-task.yml unless a more specific template fits better. pip install sumo-qa creates both sumo-qa (the MCP server binary) and sumo-qa-install (this configurator).…

  • Installs packages

The file

We split this AGENTS.md into the rules it gives an agent

6 rules. About 0 are common, 3 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    If you're an AI agent setting up sumo-qa for the user, follow this exactly.

    line 3
  2. Very specific:

    When creating GitHub issues, use the closest template in .github/ISSUE_TEMPLATE/ and include every required field in the issue body.

    line 7
  3. Distinctive:

    Use these when you only want to configure one host:

    line 28
  4. Very specific:

    After running sumo-qa-install, in VS Code: Cmd+Shift+P → Developer: Reload Window.

    line 60
  5. Distinctive:

    Use Agent mode (not Ask, not Edit) in Copilot Chat.

    line 61
  6. Distinctive:

    Use a capable model: Claude Sonnet 4.5 or GPT-5 (full).

    line 62

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

AGENTS.md, sumo-qa setup

If you're an AI agent setting up sumo-qa for the user, follow this exactly. One command for the common case; per-host flags if you only need to wire one host.

GitHub issue creation

When creating GitHub issues, use the closest template in .github/ISSUE_TEMPLATE/ and include every required field in the issue body. For implementation tasks raised by an AI agent, use .github/ISSUE_TEMPLATE/ai-task.yml unless a more specific template fits better.

Default: configure every detected host

python -m pip install sumo-qa
python -m sumo_qa.installer

pip install sumo-qa creates both sumo-qa (the MCP server binary) and sumo-qa-install (this configurator). Use python -m sumo_qa.installer for setup because it works even when the pip Scripts directory is not on PATH yet.

What sumo-qa-install does:

  1. Locates the sumo-qa MCP binary. If pip install sumo-qa already put it on PATH (the common case), uses that path directly: no uv invocation. If sumo-qa is not on PATH yet, falls back to uv tool install and prints uv install instructions if uv is also missing.
  2. Claude Code (if ~/.claude/ exists): symlinks each skills/<name>/ into ~/.claude/skills/<name>/. Writes claude_desktop_config.json with the MCP entry pointing at the absolute binary path.
  3. VS Code + Copilot (if cwd is a workspace with .git / .vscode / package.json / etc.): writes .vscode/mcp.json with the VS Code-native schema (servers key, type: stdio).
  4. JetBrains IDEs (if JetBrains config dir exists): prints exact Settings UI steps. JetBrains' MCP plugin requires Settings UI registration: external XML writes don't reliably register the runtime coroutine.
  5. Verifies the binary responds to JSON-RPC initialize.

Per-host flags

Use these when you only want to configure one host:

python -m sumo_qa.installer --claude-code              # Claude Code only
python -m sumo_qa.installer --vscode                   # VS Code workspace (cwd-based)
python -m sumo_qa.installer --vscode --workspace /path/to/repo
python -m sumo_qa.installer --jetbrains                # Prints JetBrains UI steps only
python -m sumo_qa.installer --vscode --skip-mcp-install   # Skip uv reinstall for speed
python -m sumo_qa.installer --profile core             # Save the MCP tool profile, then configure every detected host
python -m sumo_qa.installer --profile core --vscode    # Save the profile, then configure VS Code only

Re-runs are idempotent.

Updating

python -m pip install --upgrade sumo-qa     # refresh server + bundled skills/knowledge
python -m sumo_qa.installer                 # refresh host symlinks + MCP configs
# Restart the host or open a fresh chat — SessionStart hook re-injects new content

You only strictly need the second step when new skills are added or a host's MCP config schema changes; routine content updates flow through the existing symlinks automatically.

VS Code specifics

  • VS Code reads .vscode/mcp.json from the workspace root, not from $HOME. sumo-qa-install refuses to write to ~/.vscode/mcp.json and prints a clear error if you're cd'd into $HOME.
  • VS Code uses a different MCP schema than Claude Desktop:
    { "servers": { "sumo-qa": { "type": "stdio", "command": "...", "args": [] } } }
    sumo-qa-install writes this format. Earlier versions wrote mcpServers (the Claude Desktop schema) which VS Code silently ignored. On re-run, the installer strips the stale mcpServers key.
  • After running sumo-qa-install, in VS Code: Cmd+Shift+P → Developer: Reload Window. VS Code caches the MCP server list at startup; it doesn't re-read the file mid-session.
  • Use Agent mode (not Ask, not Edit) in Copilot Chat. Tools require Agent mode.
  • Use a capable model: Claude Sonnet 4.5 or GPT-5 (full). Mini/fast variants don't reliably call MCP tools.

JetBrains specifics

JetBrains AI Assistant's MCP config (llm.mcpServers.xml) is not reliably writable externally on IDEA 2026.1, the plugin requires its in-process Settings UI to register the runtime coroutine. sumo-qa-install prints the exact UI fields (with the absolute binary path):

Settings → Tools → AI Assistant → Model Context Protocol → + Add server
  Name:    sumo-qa
  Command: <absolute path printed by sumo-qa-install>
  Args:    (empty)
  Working directory: (empty)
Apply.

For Junie (JetBrains' agentic coding agent), drop this into ~/.junie/mcp/sumo-qa.json:

{
  "mcpServers": {
    "sumo-qa": {
      "command": "<absolute path printed by sumo-qa-install>"
    }
  }
}

Or per-project at <repo>/.junie/mcp/sumo-qa.json. Junie reads MCP configs from those directories on startup.

Verify

In any host, ask in chat:

load the QA classifications

You should get the canonical change-classification names back. If yes, the MCP is wired correctly.

After install

The host needs to re-read its MCP config:

  • Claude Code: restart the app
  • JetBrains IDEs: restart the IDE (or restart the AI Assistant tool window)
  • VS Code: Developer: Reload Window

What an AI agent can vs. must ask the user for

You (the agent) CANYou MUST ASK the user
Run python -m pip install sumo-qa then python -m sumo_qa.installer (with whatever host flags)Restart their host application(s) after install
Run the verification callAnything that requires admin / sudo elevation
Re-run python -m sumo_qa.installer to refreshThe JetBrains AI Assistant Settings UI add (it's a clicks-only flow; can't be scripted)
Verify Junie's ~/.junie/mcp/sumo-qa.json file content

Review guidelines

  • On release-please PRs (chore(main): release X.Y.Z), do not flag a file in the git add list of the "Regenerate version-bearing assets" step in .github/workflows/release-please.yml as stale against the new version (for example .claude-plugin/marketplace.json, assets/preview-doctor.*, plugin_packaging/generated/manifest.json). That step regenerates those files after the version bump and commits any that changed to the release PR branch.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.