{
  "markdown": "# Qt AI Skills\n\nOfficial agentic skills for Qt software development\nand quality assurance, designed for use with AI coding tools\nsuch as Claude Code, Codex CLI, Gemini CLI, and\nGitHub Copilot.\n\nSkills have been tested with frontier LLMs from the Claude,\nGemini, and GPT model families.\n\nThere is no settled industry standard for AI skill packaging.\nEach platform has its own conventions. Our canonical format\nuses `SKILL.md` with YAML frontmatter in a directory-based\nstructure — this works natively on Claude Code, Codex CLI,\nand GitHub Copilot, and can be adapted to other platforms\nthrough condensed variants. See [CONTRIBUTING.md](CONTRIBUTING.md)\nfor the full cross-platform story.\n\n> These agentic development skills use AI and can make mistakes.\n> Always double-check the output carefully.\n>\n> Before using the skills under Qt commercial licensing, make\n> sure you have understood and agree to the\n> [Qt AI Services Terms & Conditions](https://www.qt.io/terms-conditions/ai-services-2025-06).\n> By using the skills or MCP tools, you accept these terms &\n> conditions and that you have the right to do so on behalf of\n> your employer.\n\n## Skills\n\n| Skill | Type | Description |\n|-------|------|-------------|\n| `qt-cpp-review` | Review | Deterministic linting + 6 parallel deep-analysis agents for Qt C++ code. Covers model rule compliance, memory ownership, thread safety, correctness, error handling, and performance. |\n| `qt-qml-review` | Review | Deterministic QML linting (47+ rules) + parallel deep-analysis agents for bindings, layout, loaders, delegates, states, and performance. |\n| `qt-qml` | Conceptual | QML best practices for writing, reviewing, fixing, and refactoring. Corrects systematic LLM pre-training biases around bindings, scoping, modules, JS interop, and types. |\n| `qt-ui-design` | Conceptual | UI design and audit for Qt/QML, web, and embedded (MPU/MCU) targets. Covers screen layout, navigation, and UX review with platform-aware defaults for geometry, viewing distance, input, and locale. |\n| `qt-qml-docs` | Process | Generates Markdown reference documentation for QML components and applications from .qml source files. |\n| `qt-cpp-docs` | Process | Generates Markdown reference documentation for Qt/C++ source files — classes, modules, utilities, headers, and entry points. |\n| `qt-qml-profiler` | Tool | Runs `qmlprofiler` on a 2D QML / Qt Quick application, parses the `.qtd` trace, and analyzes hotspots against the source code with frame-time, memory, and pixmap-cache summaries. Does not cover Qt Quick 3D. |\n| `qt-qml-test` | Process | Generates Qt Quick Test cases (`tst_*.qml`) for QML components using `TestCase`, `SignalSpy`, and `tryCompare`. Handles single files and batches. Does not cover CMake or runner setup. |\n| `qt-qml-test-run` | Tool | Builds and runs Qt Quick Test (`qmltestrunner`) tests for a CMake project, parses the JUnit XML, and writes a Markdown report. Opt-in CMake test-infrastructure wiring with `--wire-up`. Companion to `qt-qml-test`. |\n| `qt-figma-token-extraction` | Process | Extracts design tokens, text styles, and variables from a Figma design system and produces a design-tokens.json plus ready-to-use QML singletons. |\n| `qt-figma-component-generation` | Process | Extracts component metadata from a Figma design system and generates production-ready QML controls mapped to Qt Quick Controls 2 patterns. Requires tokens from `qt-figma-token-extraction`. |\n| `qt-cmake-project` | Conceptual | Sets up and manages Qt 6 projects built with CMake — fresh projects, executables, libraries, QML modules, plugins, folder layout, and static resources. Corrects systematic LLM biases around qmake-isms and the legacy `qt5_*` macros. |\n\n### Skill types\n\n- **Review** — structured code review workflows combining\n  deterministic linters with deep AI analysis\n- **Process** — workflows and decision frameworks\n  (architecture, build, test, documentation)\n- **Conceptual** — mental model corrections for areas where\n  LLMs consistently fail (declarative QML, C++/QML boundary,\n  Widgets patterns, UI design)\n- **Tool** — guidance on Qt CLI tools and testing solutions\n\n## MCP Tools\n\n| Tool | Description |\n|------|-------------|\n| `qt-documentation-mcp` | Hosted MCP server for Qt API documentation lookup across the latest release and active LTS branches. Bundled with the `qt-development-skills` plugin; also available standalone via the official MCP registry as `io.qt/qt-documentation-mcp`. |\n\n### Qt Documentation MCP Tool\n\nSee [`mcp/qt-documentation-mcp/README.md`](mcp/qt-documentation-mcp/README.md)\nfor endpoint and manual setup instructions for AI clients other than\nClaude Code.\n\n## Repository Structure\n\n```\nskills/                           # All skills live here\n  qt-cpp-review/                  #   Each skill is a directory\n    SKILL.md                      #   with a SKILL.md entry point\n    references/                   #   and optional reference docs\n      lint-scripts/\n      qt-review-checklist.md\n    platforms/                    #   Platform-specific variants\n  qt-qml-review/\n  qt-qml/\n  qt-ui-design/\n  qt-qml-docs/\n  qt-cpp-docs/\n  qt-qml-profiler/\n  qt-qml-test/\n  qt-qml-test-run/\n  qt-cmake-project/\nmcp/                              # MCP servers bundled with the plugin\n  qt-documentation-mcp/           #   Each server is a directory\n    README.md                     #   with its own README\n.mcp.json                         # MCP registration for Claude Code\n.claude-plugin/                   # Claude Code CLI & Copilot CLI plugin config\ngemini-extension.json             # Gemini CLI extension manifest\ndocs/                             # Source for the docs site (MkDocs)\nCONTRIBUTING.md\nLICENSE\nREADME.md\n```\n\n## Skill Format\n\nEvery skill is a directory containing a `SKILL.md` file with\nYAML frontmatter. This format aligns with what Claude Code and\nCodex CLI support natively:\n\n```yaml\n---\nname: qt-qml-review\ndescription: >-\n  Reviews QML source files for correctness, performance, and\n  maintainability. Deterministic linting (47+ rules) plus\n  parallel deep-analysis agents for bindings, layout, loaders,\n  delegates, states, and performance.\nlicense: LicenseRef-Qt-Commercial OR BSD-3-Clause\ncompatibility: >-\n  Designed for Claude Code, GitHub Copilot, and similar agents.\nmetadata:\n  author: qt-ai-skills\n  version: \"1.0\"\n  qt-version: \"6.x\"\n---\n```\n\n### Key conventions\n\n- **`name`** must be lowercase alphanumeric + hyphens, max\n  64 chars, and must match the directory name\n- **`description`** must describe what the skill does AND when\n  to use it — front-load the key information in the first 250\n  characters, as some platforms truncate beyond that point\n- **SKILL.md body** should stay under 500 lines — move detailed\n  content to `references/` files\n- **Progressive disclosure**: agents load only\n  `name`/`description` at startup, read `SKILL.md` body on\n  activation, and pull `references/` files only when needed\n\n## Multi-Tool Support\n\nSkills are authored to be tool-agnostic wherever possible.\nHowever, different AI coding tools consume skills in different\nways:\n\n| Tool | Skill Location | Format | Notes |\n|------|---------------|--------|-------|\n| **Claude Code CLI** | `~/.claude/skills/` | SKILL.md + references (native) | Full directory model with progressive loading |\n| **Codex CLI** | `~/.codex/skills/` | SKILL.md + references (native) | Full directory model; registered in `~/.codex/config.toml` |\n| **Gemini CLI** | Extension `skills/` | SKILL.md + references (native) | Installed via `gemini extensions install`; `@file.md` imports |\n| **GitHub Copilot** | `.github/skills/` or `.claude/skills/` (project), `~/.copilot/skills/` (personal) | SKILL.md + references (native) | Auto-discovered across Copilot CLI, coding agent, and VS Code; existing `.claude/skills/` setups Just Work |\n\n### When platform-specific variants are needed\n\nMost skills work across tools without changes. When a skill\nneeds to reach platforms that cannot read multi-file directories\n(e.g. Windsurf, Amazon Q), create variants in a `platforms/`\ndirectory:\n\n```\nskills/qt-qml-review/\n├── SKILL.md                       # Core skill (tool-agnostic)\n├── references/\n│   ├── qml-lint-rules.md\n│   └── qml-review-checklist.md\n└── platforms/                     # Platform-specific variants\n    └── windsurf.md                #   Self-contained compact variant\n```\n\nThe `platforms/` directory is a convention for this repository.\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for full details on\ncreating platform variants.\n\n## Installation\n\nMost AI coding tools can install skills directly from this\nGitHub repository. Choose the method for your platform below.\n\n### Claude Code CLI\n\nInstall as a plugin using the Claude Code CLI plugin system:\n\n```\n/plugin marketplace add TheQtCompanyRnD/agent-skills\n/plugin install qt-development-skills\n```\n\nOr install individual skills manually:\n\n```bash\n# Symlink a skill into your personal skills directory\nln -s \"$(pwd)/skills/qt-qml-review\" ~/.claude/skills/qt-qml-review\n\n# Or copy into a project for team use\ncp -r skills/qt-qml-review .claude/skills/qt-qml-review\n```\n\nClaude Code auto-discovers skills — no restart needed.\n\n### Codex CLI\n\nUse Vercel's cross-platform skill installer:\n\n```bash\nnpx skills add TheQtCompanyRnD/agent-skills\n```\n\nOr copy skills manually:\n\n```bash\ncp -r skills/qt-qml-review ~/.codex/skills/qt-qml-review\n```\n\nRestart Codex after adding skills.\n\n> **Note:** Codex is evolving rapidly. If `~/.codex/skills/`\n> does not work, try `~/.agents/skills/` or `.agents/skills/`\n> in your project root.\n\n### GitHub Copilot CLI\n\nCopilot natively reads the same `SKILL.md` directory format as\nClaude Code. Install individual skills using GitHub CLI (preview):\n\n```bash\ngh skill install TheQtCompanyRnD/agent-skills qt-qml-review\n```\n\nOr copy/symlink the skill into one of Copilot's discovery paths:\n\n```bash\n# User-wide (available in any project)\ncp -r skills/qt-qml-review ~/.copilot/skills/qt-qml-review\n\n# Or scoped to a specific project\ncp -r skills/qt-qml-review .github/skills/qt-qml-review\n```\n\nCopilot also auto-discovers skills installed for Claude Code\nunder `.claude/skills/`, so a single install can serve both\ntools. Use `/skills list` inside Copilot CLI to confirm what\nloaded.\n\n### VSCode Agents (Copilot and others)\n\nRun `Chat: Install Plugin From Source` from the Command Palette.\nEnter `https://github.com/TheQtCompanyRnD/agent-skills` (this repo) to clone and install\n\n### Gemini CLI\n\nInstall as an extension:\n\n```bash\ngemini extensions install https://github.com/TheQtCompanyRnD/agent-skills\n```\n\nOr import skills into your project's context file:\n\n```bash\n# Add to GEMINI.md (loaded automatically)\necho '@skills/qt-qml-review/SKILL.md' >> GEMINI.md\n```\n\n## Documentation site\n\nA browsable documentation site is built from the `docs/` directory\nusing [MkDocs Material](https://squidfunk.github.io/mkdocs-material/)\nand published at:\n\n> **<https://doc.qt.io/agentictools/>**\n\nThe canonical repo is on Gerrit\n(`codereview.qt-project.org/qtai/qtaiskills`); doc.qt.io builds are\ndriven by the `qtaiskills` Rundeck job in `tqtc-doctools` on each\npush to the publishing branch.\n\n### Local preview\n\nRequires Python 3.12+:\n\n```bash\npip install -r requirements-docs.txt\nmkdocs serve\n```\n\nThen open <http://127.0.0.1:8000/agent-skills/> — the dev server\nlive-reloads on every save.\n\n### Production build\n\n```bash\nmkdocs build --strict\n```\n\nOutput goes to `site/`. `--strict` fails on broken links and\nmalformed nav, matching the GitHub Actions check.\n\n### Adding a new skill page\n\n1. Create `docs/skills/<skill-name>.md` (use an existing skill page\n   as a template).\n2. Add it to `nav:` in `mkdocs.yml`.\n3. Add a row to the table in `docs/skills/index.md`.\n4. Run `mkdocs serve` to verify.\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines\non authoring new skills, including:\n\n- Naming conventions and frontmatter requirements\n- How to structure progressive disclosure\n- Testing skills across AI coding tools\n- When and how to create platform-specific variants\n\n## License\n\nBSD-3-Clause — see [LICENSE](LICENSE) for details.\n",
  "bytes": 12125,
  "sha": "7d1a72778182a28e51b08c2e2a777c67d6c37485abe7da281d7f37d0545a1b58",
  "repo_slug": "theqtcompanyrnd/agent-skills",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/plg_theqtcompanyrnd_agent_skills_qt_developm_19d15a7e/readme"
}