From 9371f652512cb7e23e59db60353c52318b039635 Mon Sep 17 00:00:00 2001 From: Egor Pavlikhin Date: Wed, 9 Sep 2026 11:00:03 +1000 Subject: [PATCH 1/2] LLMs.txt docs --- src/pages/docs/api/index.mdx | 16 +++++++++++++++- src/pages/docs/octopus-ai/index.mdx | 8 +++++++- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/src/pages/docs/api/index.mdx b/src/pages/docs/api/index.mdx index 3ef5ebbba0..a5431b4c90 100644 --- a/src/pages/docs/api/index.mdx +++ b/src/pages/docs/api/index.mdx @@ -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 @@ -34,6 +34,20 @@ https:///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:///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. + +This endpoint was previously available at `/api/experimental/llms.txt`. The experimental route now permanently redirects to `/llms.txt`. + ## Common tasks
diff --git a/src/pages/docs/octopus-ai/index.mdx b/src/pages/docs/octopus-ai/index.mdx index 8c18156c8e..6e8ae4fdaf 100644 --- a/src/pages/docs/octopus-ai/index.mdx +++ b/src/pages/docs/octopus-ai/index.mdx @@ -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 @@ -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. From d18d6c54859b9efc8b65a2d1cf0a171539811ba7 Mon Sep 17 00:00:00 2001 From: Egor Pavlikhin Date: Wed, 9 Sep 2026 11:04:07 +1000 Subject: [PATCH 2/2] small remark --- src/pages/docs/api/index.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/pages/docs/api/index.mdx b/src/pages/docs/api/index.mdx index a5431b4c90..a5edb4c771 100644 --- a/src/pages/docs/api/index.mdx +++ b/src/pages/docs/api/index.mdx @@ -46,6 +46,8 @@ The summary is generated from your Server's API and step definitions. It include 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