From 804f3ba43afbc43c287b27e75f9f7e63d6c5fb2d Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 9 Dec 2025 23:20:39 +0000 Subject: [PATCH 1/2] Update ai/agent.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- ai/agent.mdx | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/ai/agent.mdx b/ai/agent.mdx index 02496f6e7..091ed2f09 100644 --- a/ai/agent.mdx +++ b/ai/agent.mdx @@ -52,6 +52,47 @@ Use the agent in Slack to collaborate with your team on documentation updates. 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). +## Customize agent behavior + +You can provide custom instructions to the agent by creating an `Agents.md` or `AGENTS.md` file in your repository. The agent reads this file and follows the instructions you provide when working on your documentation. + +### File location + +Place the file in one of these locations (the agent checks in this order): + +1. Your content directory (if configured in `docs.json`) +2. Your repository root + +### File naming + +Use either filename: +- `Agents.md` +- `AGENTS.md` + +### Custom instructions + +Add any instructions you want the agent to follow. The agent appends these instructions to its system prompt, so they influence all of its responses and actions. + +Examples of custom instructions: + +```markdown Agents.md +Always use TypeScript for code examples instead of JavaScript. + +When documenting API endpoints, include rate limiting information. + +Use British English spelling throughout the documentation. +``` + +```markdown Agents.md +Respond in a friendly, conversational tone. + +Always include error handling examples in code snippets. + +When updating authentication docs, mention our SSO options. +``` + +The agent applies these instructions to all tasks, whether you're using it in the dashboard, Slack, or via the API. + ## Embed the agent via API 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). From c74d89decb0ef79fb5f2b9285b5dd752b33a7af6 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 9 Dec 2025 16:38:20 -0800 Subject: [PATCH 2/2] copyedit --- ai/agent.mdx | 35 ++++++----------------------------- 1 file changed, 6 insertions(+), 29 deletions(-) diff --git a/ai/agent.mdx b/ai/agent.mdx index 091ed2f09..ab93dc86e 100644 --- a/ai/agent.mdx +++ b/ai/agent.mdx @@ -54,41 +54,18 @@ The agent can only access repositories that you connect through the Mintlify Git ## Customize agent behavior -You can provide custom instructions to the agent by creating an `Agents.md` or `AGENTS.md` file in your repository. The agent reads this file and follows the instructions you provide when working on your documentation. +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. -### File location +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. -Place the file in one of these locations (the agent checks in this order): +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. -1. Your content directory (if configured in `docs.json`) -2. Your repository root - -### File naming - -Use either filename: -- `Agents.md` -- `AGENTS.md` - -### Custom instructions - -Add any instructions you want the agent to follow. The agent appends these instructions to its system prompt, so they influence all of its responses and actions. - -Examples of custom instructions: - -```markdown Agents.md -Always use TypeScript for code examples instead of JavaScript. +```markdown Examples of custom instructions +Always use TypeScript for code examples. Never use JavaScript. When documenting API endpoints, include rate limiting information. -Use British English spelling throughout the documentation. -``` - -```markdown Agents.md -Respond in a friendly, conversational tone. - -Always include error handling examples in code snippets. - -When updating authentication docs, mention our SSO options. +Use ISO 8601 (YYYY-MM-DD) format for dates. ``` The agent applies these instructions to all tasks, whether you're using it in the dashboard, Slack, or via the API.