Teach Promptless a custom task
Overview
Section titled “Overview”Promptless ships with default behaviors, such as reviewing code PRs for documentation impact. Teach it a custom task when you want it to do something new on a regular basis. For example, it can review contributor PRs in your docs repository or turn weekly analytics into doc-gap suggestions.
A custom task has two parts:
| Part | What it decides | Where it lives |
|---|---|---|
| A trigger | When Promptless runs | The Triggers tab of the Configuration page |
| A written workflow | What Promptless does when it runs | A file under doc_workflow/ in your Knowledge Base, or an Agent Skill in a doc collection |
An “If, then” hook in PROMPTLESS.md connects the two, so Promptless follows the workflow when the trigger activates. You can pair a workflow with any supported trigger type. Your instructions can add to Promptless’s default behavior or change it.
Custom tasks act on new events, such as a PR opening. They don’t scan or audit the pages you already have. For one-time work across your whole docs set, such as an audit, a retrofit, or writing from scratch, use Deep Analysis.
Before you start
Section titled “Before you start”- The integration that the trigger depends on, connected to Promptless. For example, the GitHub integration for a task that starts from a GitHub PR.
- An admin role in your Promptless organization, to edit the Knowledge Base and Configuration page. Alternatively, ask Promptless in Slack or Microsoft Teams to make the edits for you.
Write the workflow
Section titled “Write the workflow”The workflow holds the instructions Promptless follows once the trigger activates. Make it concrete. Say what to check, what to prioritize, and what output to produce, so Promptless knows what a successful run looks like.
-
Write the workflow in one of these places:
-
A Markdown file under
doc_workflow/in your Agent Knowledge Base, such asdoc_workflow/review-inbound-doc-prs.md. -
An Agent Skill in a doc collection, under
.claude/skills/,.agents/skills/, or.cursor/skills/in your docs repository.
-
-
In
PROMPTLESS.md, add an “If, then” hook that points to the workflow, in the form “If [condition], then [do this].” When the workflow is an Agent Skill, name the doc collection it lives in. For example: “When a contributor PR is opened inacme/docs, use thecontributor-workflowskill from the Acme doc collection.” -
Save your changes. An organization admin can edit the files in the Agent Knowledge Base. You can also ask Promptless to make the edits, and it commits them for you.
Add the trigger
Section titled “Add the trigger”The trigger decides when your workflow runs. For example, a GitHub PR trigger can activate when a PR is opened. A Slack channel trigger can act on messages that meet criteria you describe.
-
On the Configuration page, open the Triggers tab.
-
Select Add an automatic or scheduled trigger, then select the trigger type.
-
Fill in the trigger’s settings, such as the repositories or channels to watch.
-
Select Add trigger.
When the trigger activates on a qualifying event, Promptless reads the context for that event, follows your workflow, and produces the output your instructions define. The context it reads and the output it produces depend on the workflow you write.
Follow an end-to-end example
Section titled “Follow an end-to-end example”Each example walks through the prerequisites, workflow instructions, trigger YAML, and PROMPTLESS.md hook for one task.
See also
Section titled “See also”- How Promptless learns your docs, for where Promptless reads custom guidance and Agent Skills
- Configuration reference, for every trigger type and field
- Ask Promptless to update your configuration, to set up triggers from Slack or Teams
- Shape how Promptless communicates with your team, to change where Promptless posts, whom it mentions, and what its messages say