Skip to main content
Markdown

AI Assistants

So that AI assistants answer questions about Workist from this documentation instead of from memory, Workist provides a skill. Independently of that, every page is available as Markdown.

The "workist-docs" skill​

The skill gives Claude and other AI agents instructions for questions about Workist:

  • For each question it reads the relevant pages of this documentation and answers with the path in the channel configuration, the exact setting names and a link to the page.
  • Before a customer-specific change, a workaround or a ticket is planned, it checks whether the requirement can already be met through configuration.
  • It replies in the language of the question.

The skill contains no documentation content; it fetches the documentation anew for every question. Changes to the documentation therefore take effect immediately; you only need to reinstall the skill when the skill itself changes.

FileUse
workist-docs.skillClaude Desktop, install by double-click
workist-docs.zipUpload in Claude in the browser
SKILL.mdClaude Code and other AI agents

Setup​

Claude Desktop​

  1. Download workist-docs.skill.
  2. Double-click the file. It opens in Claude Desktop.
  3. Confirm the import and check under Customize → Skills that the skill is turned on.
  4. Allow docs.workist.com, see Network access.

Claude in the browser​

  1. Download workist-docs.zip.
  2. In Claude, open Customize → Skills and upload the ZIP file.
  3. Turn the skill on.
  4. Allow docs.workist.com, see Network access.

On Team and Enterprise plans, admins can make the skill available to the whole organization with Publish to org.

Network access​

So that Claude Desktop and Claude in the browser can fetch the documentation, docs.workist.com must be allowed: allow the domain under Settings → Capabilities in Allow network egress. On Team and Enterprise plans, the organization owner sets this under Organization settings → Capabilities.

Claude Code​

For all your projects:

mkdir -p ~/.claude/skills/workist-docs
curl -fsSL https://docs.workist.com/skills/workist-docs/SKILL.md -o ~/.claude/skills/workist-docs/SKILL.md

For a single repository, put the file at .claude/skills/workist-docs/SKILL.md in the repository instead. The skill is then available to everyone who works in that repository.

So that Claude Code can fetch the documentation without asking each time, allow the domain in ~/.claude/settings.json or in the repository's .claude/settings.json:

{
  "permissions": {
    "allow": ["WebFetch(domain:docs.workist.com)"]
  }
}

Other AI agents​

Tools that support the open Agent Skills standard, for example Cursor, GitHub Copilot, Gemini CLI and OpenAI Codex, install the skill with:

npx skills add https://docs.workist.com/skills/workist-docs/SKILL.md

Documentation as Markdown​

For AI assistants without the skill, the documentation is available following the llms.txt standard:

FileContent
llms.txt (English), llms.txt (German)Index of all pages with a short description
llms-full.txt (English), llms-full.txt (German)The entire documentation in one file
A page's address with the extension .mdThat page as Markdown, for example https://docs.workist.com/en/docs/ai-assistants.md