Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/workflows/llmstxt.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,14 @@ on:
- "app/en/**/*.mdx"
- "app/en/**/_meta.tsx"
- "scripts/generate-llmstxt.ts"
- "toolkit-docs-generator/data/toolkits/**"
pull_request:
types: [opened, synchronize, reopened]
paths:
- "app/en/**/*.mdx"
- "app/en/**/_meta.tsx"
- "scripts/generate-llmstxt.ts"
- "toolkit-docs-generator/data/toolkits/**"

permissions:
contents: write
Expand All @@ -24,6 +26,9 @@ jobs:
llmstxt:
name: Generate LLMSTXT
runs-on: ubuntu-latest
if: >
(github.event_name != 'pull_request' ||
github.event.pull_request.head.repo.full_name == github.repository)

permissions:
contents: write
Expand All @@ -40,6 +45,7 @@ jobs:
with:
ref: ${{ github.event.pull_request.head.ref || github.ref }}
token: ${{ secrets.DOCS_PUBLISHABLE_GH_TOKEN }}
fetch-depth: 0

- name: Install dependencies
run: npm install -g pnpm
Expand Down
9 changes: 3 additions & 6 deletions app/en/get-started/setup/connect-arcade-docs/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,11 @@ description: "Learn how to speed up your development with agents in your IDEs"

# Agentic development

Every page on the Arcade docs site serves as markdown. When an AI agent or coding assistant visits any docs URL, the site automatically returns `Content-Type: text/markdown` instead of HTML if:
Arcade publishes an [`llms.txt`](/llms.txt) index that agents can use to discover documentation pages.

- The request `User-Agent` header matches a known AI agent (Claude, ChatGPT, Cursor, etc.)
- The request includes the `Accept: text/markdown` header
Generated toolkit reference pages also provide complete Markdown through the **Copy page** action. This Markdown includes tool parameters, authentication requirements, outputs, examples, and custom documentation sections that load on demand in the rendered page.

This means you can point your agent directly at any docs page. No need to copy and paste or use the `llms.txt` file. The agent will receive well-formatted markdown out of the box.

For example, you can tell your agent to visit `docs.arcade.dev/get-started/quickstarts/call-tool-agent` and it will automatically get the markdown version of that page.
Other documentation URLs serve HTML. Use `llms.txt` to give an agent the documentation index, or use **Copy page** when you need Markdown for a specific page.

## LLMs.txt

Expand Down
Loading
Loading