Workshop and AI agents¶
Workshop integrates with AI coding agents, exposing documentation as Markdown that agents can fetch and parse directly, or retrieve through Context7, and agentic skills that wrap Workshop and SDKcraft operations so agents don’t have to rediscover the CLIs every session.
LLM-readable docs¶
AI agents← Use with AI agents|Workshop skill →
Workshop publishes two files that follow the llms.txt convention: llms.txt indexes every page with a one-line summary, and llms-full.txt concatenates every page as Markdown.
To fetch a single page as Markdown,
append .md to its URL.
For example,
this page is available at
https://ubuntu.com/workshop/docs/reference/ai-agents.md.
Context7¶
Context7 indexes the Workshop documentation and serves it to AI agents through its Model Context Protocol (MCP) server, so agents can pull current docs without scraping the site.
The use-workshop skill¶
AI agents← LLM-readable docs|SDK design skill →
The use-workshop-skill repository ships an agentic skill for operating the Workshop CLI: launching workshops, refreshing them, running commands inside, wiring interfaces, debugging failed changes, and orchestrating parallel environments via Git worktrees.
If your agent supports plugins,
install the repository as a plugin:
run /plugin marketplace add canonical/use-workshop-skill,
then /plugin install use-workshop@canonical.
Otherwise,
copy .github/skills/use-workshop/ into the target repo,
using the skills path for your agent
(.claude/skills/ for Claude Code,
.github/skills/ for Copilot, and so on).
Mention Workshop in any prompt to trigger the skill.
The design-sdk skill¶
The same repository ships design-sdk,
an agentic skill for the publisher side:
designing, building, and publishing SDKs with SDKcraft.
The skill runs an interactive design conversation:
it asks about the software to package,
how upstream distributes it,
what must persist across refreshes,
which network services and hardware it needs,
and which bases and architectures to build for,
then proposes a design for approval.
Once approved,
it writes sdkcraft.yaml, the hooks, and spread tests,
iterates with sdkcraft try and workshop refresh
until the SDK comes up healthy,
and writes the README.
On request,
it also onboards the SDK repository
with version branches, CI workflows, and a renovate.json,
and publishes the SDK to the SDK Store.
The skill installs together with use-workshop:
the plugin carries both,
and when copying the skill directories instead,
copy .github/skills/design-sdk/
alongside .github/skills/use-workshop/,
as design-sdk reads its sibling’s references.
Aim the agent at the new repository.
Run
/design-sdk new <SOFTWARE>and answer the prompts. Run/design-sdkwithout arguments to pick one of the skill’s other paths instead, such asiterate,test,onboard, orpublish.Approve the proposed design, then review the generated files and adjust where the skill’s defaults don’t match your case.