Build an agent knowledge base
Overview
Section titled “Overview”The Agent Knowledge Base holds the files Promptless reads to understand your documentation style, product context, and workflow preferences. Promptless updates these files as it learns from your feedback. Open the Knowledge Base to check what Promptless has learned, correct an assumption it made, or add instructions it follows on every task.
All organization members can view the files. Only organization admins can edit or create them.
View files
Section titled “View files”-
In the left sidebar, open Settings and select Agent Knowledge Base.
-
In the file tree, select a file to open it in the editor.
The URL updates with a ?file=<path> query parameter for the open file. Bookmark or share that URL to open the editor to the file. Recipients need their own access to your organization to open it. Your browser’s back and forward buttons move between the files you’ve viewed.
Know the files that shape every task
Section titled “Know the files that shape every task”Four files shape how Promptless works for your whole organization. The file tree marks each one with the Promptless logo, and the editor explains the file’s role above its contents. Promptless marks only these exact paths, so a file with the same name in another folder, such as notes/PROMPTLESS.md, has no logo.
| File | What it controls |
|---|---|
PROMPTLESS.md | Instructions Promptless receives at the start of every session. Put rules Promptless must always follow here, including the “If, then” hooks that activate custom tasks. |
promptless.yaml | Your triggers, doc collections, context sources, and policies. Edit it on the Configuration page. See the Configuration reference. |
style/client_style_guide.md | Your documentation style guide, which Promptless reads before it writes or revises your docs. Reference your repository’s style guide or Vale rules here. Promptless adds the style preferences it learns from feedback. |
doc_workflow/notification_preferences.md | Your preferences for the notifications Promptless sends, such as whom it mentions and how it formats messages. Promptless reads it when it writes a notification. See Customize notifications. |
Promptless reads the other files in the Knowledge Base when a task calls for them.
Review the doc collection analysis
Section titled “Review the doc collection analysis”When you connect a docs repository, Promptless studies your existing documentation, the repository’s full commit history, and your public docs site. It records what it learns in a collection_analyses/ folder, with one subfolder for each connected docs repository. Promptless reads this analysis at the start of every documentation task, so its suggestions reflect how your product and docs work.
Each analysis folder contains these files:
| File | Contents |
|---|---|
README.md | An index of the analysis and its headline findings. |
product-overview.md | What your product does, its key concepts, and terminology. |
audience-and-personas.md | Who your documentation serves and what knowledge each reader is assumed to have. |
content-strategy.md | Critical user journeys, where new content belongs, and gaps in your information architecture. |
team-workflows.md | Patterns from your commit history, such as update cadence, authorship, and which pages tend to change together. |
style-observations.md | Voice, formatting, and terminology patterns observed in your docs. |
Promptless generates the analysis when you connect the repository, so it reflects your documentation at that time. If you’ve connected Slack or Microsoft Teams, Promptless notifies your configured channel when the analysis finishes. Otherwise, the files appear in the Agent Knowledge Base when it’s done.
During analysis, Promptless also writes Vale rules from your style guidance and records them under a style/rules/ folder. See Vale rules.
Track what Promptless changed
Section titled “Track what Promptless changed”Promptless can update these files when you give feedback on suggestions through PR comments, the Promptless dashboard, or Slack. It applies what it learned to future tasks. The Recent updates by Promptless list shows its latest changes. Each entry shows:
- The date of the update
- The files changed, with a diff for each
- A link to the suggestion that prompted the update, when there is one
Edit files
Section titled “Edit files”Only organization admins can edit Knowledge Base files. Other members see each file as view-only, with no Save button.
-
Open the file and make your changes in the editor.
-
Select Save.
Promptless commits your changes directly to the Knowledge Base repository.
Create files
Section titled “Create files”-
Select the + button next to a folder to create a file in it. To create a top-level file, select the new-file icon at the root.
-
In the New file dialog, enter a file name without the
.mdextension. Promptless adds the extension. To create the file in new folders, enter a path such asnested/path/filename, and Promptless creates the folders. -
Select Create.
The new file opens in the editor.
See also
Section titled “See also”- Teach Promptless a custom task, to pair a trigger with a written workflow and a
PROMPTLESS.mdhook - Teach conventions with feedback, for the feedback that updates these files
- Configuration reference, for every
promptless.yamlfield - Get support, if you need help with your Knowledge Base