agentleFS
ulises-jeremiasulises-jeremias/agent-toolkit/skills/quality/codeql/SKILL.md

codeql

Skill19 starsChanged 2 months agoMITView on GitHub

CodeQL operational workflow — discover/config, run/inspect, triage SARIF findings (rule/query ID, source→sink, evidence), remediate, re-validate. Distinguishes broad MegaLinter linting from semantic security analysis.

12 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

6 rules. 0 are common, 2 are distinctive, and 4 are very specific to this project.

  • 0

    Common

    Most of the 12 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 4

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Distinctive:

    Do not split into separate skills — routing is via the mode table above.

    line 37
  2. Very specific:

    Do not dismiss as false positive without evidence.

    line 63
  3. Very specific:

    If evidence insufficient: status Needs investigation is valid — do not mark fixed or false positive without code proof.

    line 82
  4. Very specific:

    Do not duplicate workflows: When both are needed, run megalinter-check for hygiene and codeql triage for security.

    line 94
  5. Distinctive:

    Never auto-suppress a CodeQL alert without user confirmation — suppression hides a security finding.

    line 98
  6. Very specific:

    Never push to main to fix a CodeQL alert — create branch codeql/fix-<rule>-<id>, fix, push, verify analyze passes.

    line 99

“Common” is measured: kept by at least 6 in 10 of the 12 edited versions of this file we could read. “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
SKILL.md

CodeQL — Operational Security Analysis Workflow

Help coding agents operate CodeQL, not just explain syntax. Covers discovery of existing setup, config review, scan execution/inspection, SARIF triage with evidence discipline, remediation, and targeted re-validation.

Sources: GitHub Docs Code Scanning with CodeQL (2026-08-12, https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql), CodeQL CLI (github/codeql MIT, CLI binaries separate), github/codeql-action (https://github.com/github/codeql-action), and this repo's .github/workflows/codeql.yml (Analyze Python via codeql-action/init@v4 + analyze@v4).

Relationship to MegaLinter:

  • MegaLinter: broad linting/formatting/static quality orchestration (50+ linters, Docker-based, .mega-linter.yml, fast feedback on style, config, IaC).
  • CodeQL: semantic security analysis / dataflow / vulnerability classes (source→sink taint, e.g., python/sql-injection, js/xss, SARIF alerts).
  • Neither replaces the other. Composition: code-quality / secure-delivery → { MegaLinter, CodeQL } without a giant orchestrator.

When to use

  • Repo has or needs CodeQL code scanning (.github/workflows/codeql.yml, codeql-action, SARIF alerts)
  • Need to triage a CodeQL alert (security tab, SARIF file, CI log) with evidence
  • Need to fix a finding and re-validate
  • Workflow failing (timeout, OOM, build failure for compiled languages, config error)
  • Need custom query / query-pack guidance (when to write vs reuse)

Modes (one skill, contextual)

ModeTriggerWhat it does
SETUP / CONFIG REVIEWNo CodeQL workflow, or outdated codeql-action version, or new language to addInspect .github/workflows/codeql.yml, languages:, queries:, paths:, paths-ignore:, schedule, permissions (security-events: write); recommend init@v4/analyze@v4 (or codeql-action latest), language matrix, build-mode for compiled (manual/autobuild/none)
FINDING TRIAGESARIF file, alert URL, or Run CodeQL log with failureParse SARIF (runs[].tool.driver.rules[], runs[].results[]), map ruleId → query help, extract locations[0].physicalLocation, codeFlows (source→sink), message.text, level/category, partialFingerprints; produce evidence table
REMEDIATIONTriaged finding with fix neededPropose minimal fix (sanitize, parameterized query, escape), show diff, reference query docs, note confidence/severity, and how to suppress via // lgtm[…] or codeql-config.yml only when justified (ask before suppress)
WORKFLOW TROUBLESHOOTINGanalyze job failed, no alerts, or out of memoryCheck codeql-action logs, AUTOBUILD vs manual build, ram: / threads:, debug: true, upload-sarif fallback, category duplication
CUSTOM QUERYNeed to detect a repo-specific pattern beyond standard packsGuide when to reuse security-and-quality vs security-extended vs write custom QL (pack codeql/<lang>-queries), use codeql pack create + codeql query run locally, test with codeql test run

Do not split into separate skills — routing is via the mode table above.

Workflow (operational loop)

DISCOVER existing CodeQL setup (workflow, languages, queries, schedule)
      ↓
RUN or INSPECT scan (CI `analyze` job or local `codeql database create` + `codeql database analyze`)
      ↓
TRIAGE findings (SARIF: ruleId, location, source→sink, evidence, confidence, severity)
      ↓
PLAN remediation (fix vs suppress vs needs investigation)
      ↓
IMPLEMENT fix (minimal, preserve semantics)
      ↓
RE-VALIDATE targeted (re-run that query / re-upload SARIF / re-check alert)
      ↓
DOCUMENT residual (fixed / suppressed with justification / needs investigation)
  1. Discover: ls .github/workflows/codeql.yml + cat (languages, on: push/pull_request/schedule, permissions, strategy.matrix.language if present). Check GitHub Security tab API (gh api repos/{owner}/{repo}/code-scanning/alerts) for open alerts, or find . -name "*.sarif" locally.
  2. Run / Inspect:
    • CI: Trigger workflow (gh workflow run codeql.yml) or watch latest run (gh run list --workflow=codeql.yml, gh run view <id>, gh run view <id> --log-failed). Prefer CI when available (no local DB build needed).
    • Local (fallback): codeql database create --language=python --source-root=. /tmp/codeql-db (compiled: add --build-mode or manual build command), then codeql database analyze /tmp/codeql-db codeql/python-queries:codeql-suites/python-security-and-quality.qls --format=sarif-latest --output=/tmp/results.sarif. Use codeql pack download for custom packs. Local needs CodeQL CLI installed (gh codeql or codeql binary, Java for DB).
  3. Triage (evidence discipline):
    • For each result in SARIF: extract ruleId (e.g., py/sql-injection), message.text, locations[0].physicalLocation.artifactLocation.uri + region (line/col), codeFlows[0].threadFlows[0].locations (source→sink), partialFingerprints.primaryLocationLineHash (stable ID), properties.severity / security-severity, level (error/warning/note).
    • Do not dismiss as false positive without evidence. If source→sink lacks a sanitizer, mark Needs investigation and propose confirming with query help link (https://codeql.github.com/codeql-query-help/python/py-sql-injection).
    • Table columns: # | ruleId | location (file:line) | source→sink | code evidence (snippet) | severity/confidence | remediation | validation | status.
  4. Remediate: Propose minimal fix with diff. For py/sql-injection: use parameterized cursor.execute("SELECT ... WHERE id = %s", (user_id,)) not f"SELECT ... {user_id}". For js/xss: escape via textContent or DOMPurify. For java/sql-injection: use PreparedStatement. Ask before adding // lgtm[py/sql-injection] or codeql-config.yml query-filters: - exclude: py/sql-injection — suppress only with justification.
  5. Re-validate: Re-run that single query pack (codeql database analyze --query-suite=... --sarif-category=python) or push branch and re-check Security tab alert state (open → fixed after merge to default branch, or dismissed if suppressed). For CI, watch new analyze run; for local, codeql database analyze with --rerun.
  6. Document residual: fixed (with commit), dismissed (reason + dismissedReason: false positive + comment), or needs investigation (insufficient evidence, e.g., custom sanitizer not modeled).

Evidence discipline (per finding)

FieldRequiredExample
ruleId / query IDYespy/sql-injection, java/sql-injection
locationYessrc/app.py:42:12 (uri + region)
source → sinkYes when taint queryrequest.args.get("id") (source, line 38) → cursor.execute(…) (sink, line 42) via codeFlows
code evidenceYesSnippet cursor.execute(f"SELECT * FROM users WHERE id = {user_id}")
confidenceYesHigh/Med/Low (from properties.precision: very-high/high/medium)
severityYeserror / warning + security-severity: 8.5
remediationYesParameterized query, or needs investigation if sanitizer unknown
validationYesre-ran py/security-and-quality on /tmp/db → 0 results for py/sql-injection or CI analyze #123 green

If evidence insufficient: status Needs investigation is valid — do not mark fixed or false positive without code proof.

MegaLinter vs CodeQL (documented)

AspectMegaLinterCodeQL
ScopeBroad linting/formatting/IaC (100+ linters, .mega-linter.yml)Semantic security / dataflow (SARIF, codeql/* packs)
RuntimeDocker ghcr.io/oxsecurity/megalinter:v10 via npx mega-linter-runnergithub/codeql-action (init/analyze) or codeql CLI + DB
OutputConsole + megalinter-reports/mega-linter-report.json + logsSARIF results.sarif + GitHub Security alerts
Fix loop≤3 bounded (safe auto-fix → targeted re-check)One finding at a time, re-analyze DB after fix
When to useEvery PR for hygieneEvery push/PR for security, plus scheduled weekly

Do not duplicate workflows. When both are needed, run megalinter-check for hygiene and codeql triage for security; share the same branch but keep SARIF vs linter reports separate.

Safety

  • Never auto-suppress a CodeQL alert without user confirmation — suppression hides a security finding.
  • Never push to main to fix a CodeQL alert — create branch codeql/fix-<rule>-<id>, fix, push, verify analyze passes.
  • For custom queries, keep them in codeql-query-pack/ with qlpack.yml and codeql test — do not edit github/codeql directly.

References

  • references/codeql-queries.md — curated query packs (security-and-quality, security-extended, security-experimental), per-language codeql/<lang>-queries locations, and when to write custom QL
  • GitHub Docs: Code scanning with CodeQL (2026-08-12), CodeQL CLI, github/codeql-action (https://github.com/github/codeql-action, MIT), github/codeql (MIT, queries)
  • This repo: .github/workflows/codeql.yml (Analyze Python, init@v4 + analyze@v4, schedule 0 6 * * 1)

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.