Skip to content

LLMs.txt docs #3455

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
egorpavlikhin merged 2 commits into from
Sep 9, 2026
+24 −2
Merged

LLMs.txt docs #3455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9371f65
LLMs.txt docs
egorpavlikhin Sep 9, 2026
d18d6c5
small remark
egorpavlikhin Sep 9, 2026
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
18 changes: 17 additions & 1 deletion src/pages/docs/api/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Default.astro
pubDate: 2026-08-20
modDate: 2026-08-20
modDate: 2026-09-09
title: Octopus API
navTitle: Get started
crumbTitle: API
Expand Down Expand Up @@ -34,6 +34,22 @@ https://<your-octopus-url>/swaggerui/
Our docs cover the latest version of the Octopus REST API. If you're on a Long Term Support (LTS) version, some endpoints and values may differ. Use the Swagger UI served by your own instance (see above) as the source of truth for your version.
:::

## API context for AI assistants (llms.txt)

Octopus Server provides a Markdown summary at `/llms.txt` to give large language models (LLMs) context for writing scripts and integrations with the Octopus REST API.

```text
https://<your-octopus-url>/llms.txt
```

The summary is generated from your Server's API and step definitions. It includes API endpoints, resource types, authentication guidance, and deployment step properties. You can provide the URL or downloaded content to your AI coding assistant as context.

Reading `/llms.txt` doesn't require authentication or an API key. API requests made using the summary still require the usual authentication and permissions.

Like Swagger documentation, the summary describes the API without exposing instance data such as your projects, deployments, or variable values.

This endpoint was previously available at `/api/experimental/llms.txt`. The experimental route now permanently redirects to `/llms.txt`.

## Common tasks

<div class="col-3">
Expand Down
8 changes: 7 additions & 1 deletion src/pages/docs/octopus-ai/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Default.astro
pubDate: 2025-04-04
modDate: 2026-07-03
modDate: 2026-09-09
title: AI-Powered DevOps with Octopus Deploy
navTitle: Overview
navSection: Octopus AI
Expand Down Expand Up @@ -70,6 +70,12 @@ The step is an alpha release. Letting an AI agent near your infrastructure is, l

[Learn more about the Claude Agent Step](/docs/octopus-ai/claude-agent-step)

## API context for AI assistants (llms.txt)

Octopus Server's `/llms.txt` endpoint provides a Markdown summary of its API and deployment step properties. You can give the URL or downloaded content to your AI coding assistant as context for writing scripts and integrations.

[Learn more about the llms.txt endpoint](/docs/api#api-context-for-ai-assistants-llmstxt)

## Getting Started

Begin your AI-powered DevOps journey today with the Octopus AI Assistant, or the Octopus MCP Server. As an Early Access participant, you'll help shape these features while gaining early access to capabilities that will transform how teams deploy software.
Expand Down