Skip to content

Commit 7403860

Browse files
Document Agents.md customization feature (#2159)
* Update ai/agent.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * copyedit --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <[email protected]>
1 parent 47925c5 commit 7403860

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

ai/agent.mdx

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,24 @@ By default, the agent opens pull requests attributed to the Mintlify bot. To att
5656

5757
The agent can only access repositories that you connect through the Mintlify GitHub App. Configure which repositories the agent can access in the agent panel **Settings** or in the [GitHub App settings](https://github.com/apps/mintlify/installations/new).
5858

59+
## Customize agent behavior
60+
61+
Add an `AGENTS.md` file in your repository to customize the agent's behavior. The agent reads this file and follows any instructions you provide.
62+
63+
Create the `AGENTS.md` file at the root of your repository. If your project is a monorepo, create the file in the root of the documentation directory.
64+
65+
Add any instructions that you want the agent to follow. The agent appends these instructions to its system prompt, so they influence all of its responses and actions.
66+
67+
```markdown Examples of custom instructions
68+
Always use TypeScript for code examples. Never use JavaScript.
69+
70+
When documenting API endpoints, include rate limiting information.
71+
72+
Use ISO 8601 (YYYY-MM-DD) format for dates.
73+
```
74+
75+
The agent applies these instructions to all tasks, whether you're using it in the dashboard, Slack, or via the API.
76+
5977
## Embed the agent via API
6078

6179
Use the agent endpoints to [create jobs](/api-reference/agent/create-agent-job), [get a specific job](/api-reference/agent/get-agent-job), and [get all jobs](/api-reference/agent/get-all-jobs).

0 commit comments

Comments
 (0)