From fd77c8303f01f7a5701613d38c526aa553857d54 Mon Sep 17 00:00:00 2001 From: umair Date: Wed, 25 Mar 2026 11:13:53 +0000 Subject: [PATCH] Adds documentation and signposts for ably agent skills --- .../getting-started/anthropic.mdx | 4 ++ .../getting-started/langgraph.mdx | 4 ++ .../ai-transport/getting-started/openai.mdx | 4 ++ .../getting-started/vercel-ai-sdk.mdx | 4 ++ .../docs/chat/getting-started/android.mdx | 4 ++ src/pages/docs/chat/getting-started/index.mdx | 4 ++ .../docs/chat/getting-started/javascript.mdx | 4 ++ src/pages/docs/chat/getting-started/jvm.mdx | 4 ++ .../chat/getting-started/react-native.mdx | 4 ++ .../chat/getting-started/react-ui-kit.mdx | 4 ++ src/pages/docs/chat/getting-started/react.mdx | 4 ++ .../getting-started/swift-async-sequence.mdx | 4 ++ src/pages/docs/chat/getting-started/swift.mdx | 4 ++ src/pages/docs/getting-started/dotnet.mdx | 4 ++ src/pages/docs/getting-started/flutter.mdx | 4 ++ src/pages/docs/getting-started/go.mdx | 4 ++ src/pages/docs/getting-started/index.mdx | 4 ++ src/pages/docs/getting-started/java.mdx | 4 ++ src/pages/docs/getting-started/javascript.mdx | 4 ++ src/pages/docs/getting-started/kotlin.mdx | 4 ++ src/pages/docs/getting-started/laravel.mdx | 4 ++ src/pages/docs/getting-started/node.mdx | 4 ++ .../docs/getting-started/objective-c.mdx | 4 ++ src/pages/docs/getting-started/php.mdx | 4 ++ src/pages/docs/getting-started/python.mdx | 4 ++ .../docs/getting-started/react-native.mdx | 4 ++ src/pages/docs/getting-started/react.mdx | 4 ++ src/pages/docs/getting-started/ruby.mdx | 4 ++ src/pages/docs/getting-started/swift.mdx | 4 ++ src/pages/docs/platform/ai-llms/index.mdx | 43 ++++++++++++++++++- 30 files changed, 157 insertions(+), 2 deletions(-) diff --git a/src/pages/docs/ai-transport/getting-started/anthropic.mdx b/src/pages/docs/ai-transport/getting-started/anthropic.mdx index f54b9583f7..35ff524d22 100644 --- a/src/pages/docs/ai-transport/getting-started/anthropic.mdx +++ b/src/pages/docs/ai-transport/getting-started/anthropic.mdx @@ -11,6 +11,10 @@ This guide will get you started with Ably AI Transport using Anthropic's Message You'll learn how to authenticate users with verified identities, stream tokens from an agent to clients in realtime, and implement human-in-the-loop approval for tool calls. The agent uses Anthropic's Claude model with a `send_email` tool that requires user approval before execution. + + ## Prerequisites 1. [Sign up](https://ably.com/signup) for an Ably account. diff --git a/src/pages/docs/ai-transport/getting-started/langgraph.mdx b/src/pages/docs/ai-transport/getting-started/langgraph.mdx index b15d278955..59fd4f5fc9 100644 --- a/src/pages/docs/ai-transport/getting-started/langgraph.mdx +++ b/src/pages/docs/ai-transport/getting-started/langgraph.mdx @@ -8,6 +8,10 @@ This guide will get you started with Ably AI Transport using LangGraph. You'll learn how to authenticate users with verified identities, stream tokens from an agent to clients in realtime, and implement human-in-the-loop approval for tool calls. The agent uses LangGraph with a `send_email` tool that requires user approval before execution. + + ## Prerequisites 1. [Sign up](https://ably.com/signup) for an Ably account. diff --git a/src/pages/docs/ai-transport/getting-started/openai.mdx b/src/pages/docs/ai-transport/getting-started/openai.mdx index b216a10797..82c3bcd0c7 100644 --- a/src/pages/docs/ai-transport/getting-started/openai.mdx +++ b/src/pages/docs/ai-transport/getting-started/openai.mdx @@ -8,6 +8,10 @@ This guide will get you started with Ably AI Transport using OpenAI's Responses You'll learn how to authenticate users with verified identities, stream tokens from an agent to clients in realtime, and implement human-in-the-loop approval for tool calls. The agent uses OpenAI's GPT model with a `send_email` tool that requires user approval before execution. + + ## Prerequisites 1. [Sign up](https://ably.com/signup) for an Ably account. diff --git a/src/pages/docs/ai-transport/getting-started/vercel-ai-sdk.mdx b/src/pages/docs/ai-transport/getting-started/vercel-ai-sdk.mdx index 7e41d920ce..976dbc2189 100644 --- a/src/pages/docs/ai-transport/getting-started/vercel-ai-sdk.mdx +++ b/src/pages/docs/ai-transport/getting-started/vercel-ai-sdk.mdx @@ -8,6 +8,10 @@ This guide will get you started with Ably AI Transport using the Vercel AI SDK. You'll learn how to authenticate users with verified identities, stream tokens from an agent to clients in realtime, and implement human-in-the-loop approval for tool calls. The agent uses the Vercel AI SDK with a `send_email` tool that requires user approval before execution. + + ## Prerequisites 1. [Sign up](https://ably.com/signup) for an Ably account. diff --git a/src/pages/docs/chat/getting-started/android.mdx b/src/pages/docs/chat/getting-started/android.mdx index dd354c2a65..3cd6abb287 100644 --- a/src/pages/docs/chat/getting-started/android.mdx +++ b/src/pages/docs/chat/getting-started/android.mdx @@ -10,6 +10,10 @@ You'll learn how to create chat rooms, send and edit messages, and implement rea ![Screenshot of the completed Android Chat application showing a web interface with connection status, a message input field, realtime message display, and a presence indicator showing online users. The interface demonstrates the key features you'll build including publishing messages, subscribing to receive messages in realtime, and tracking which clients are currently present in the channel.](../../../../images/content/screenshots/getting-started/chat-kotlin-getting-started-guide.png) + + ## Prerequisites ### Ably diff --git a/src/pages/docs/chat/getting-started/index.mdx b/src/pages/docs/chat/getting-started/index.mdx index db97eb8d84..77131d91e5 100644 --- a/src/pages/docs/chat/getting-started/index.mdx +++ b/src/pages/docs/chat/getting-started/index.mdx @@ -12,6 +12,10 @@ You'll learn the essentials of building realtime chat applications, including ho These are your first steps towards building a Chat application that can effortlessly scale to serve millions of users. + + {[ { diff --git a/src/pages/docs/chat/getting-started/javascript.mdx b/src/pages/docs/chat/getting-started/javascript.mdx index 1795696bee..848c524964 100644 --- a/src/pages/docs/chat/getting-started/javascript.mdx +++ b/src/pages/docs/chat/getting-started/javascript.mdx @@ -8,6 +8,10 @@ This guide will get you started with Ably Chat using TypeScript. You'll learn how to create chat rooms, send and edit messages, and implement realtime features like typing indicators and presence. You'll also cover message history, reactions, and proper connection management. + + ## Prerequisites 1. Sign up for an Ably account. diff --git a/src/pages/docs/chat/getting-started/jvm.mdx b/src/pages/docs/chat/getting-started/jvm.mdx index abb15b89e0..beb0a9e6c6 100644 --- a/src/pages/docs/chat/getting-started/jvm.mdx +++ b/src/pages/docs/chat/getting-started/jvm.mdx @@ -8,6 +8,10 @@ This guide will help you get started with Ably Chat in a new JVM application usi You'll learn how to create chat rooms, send and edit messages, and implement realtime features like typing indicators and presence. You'll also cover message history, reactions, and proper connection management. + + ## Prerequisites ### Ably diff --git a/src/pages/docs/chat/getting-started/react-native.mdx b/src/pages/docs/chat/getting-started/react-native.mdx index e06c4c6a38..9ff25c7ad5 100644 --- a/src/pages/docs/chat/getting-started/react-native.mdx +++ b/src/pages/docs/chat/getting-started/react-native.mdx @@ -10,6 +10,10 @@ You'll learn how to create chat rooms, send and edit messages, and implement rea ![Screenshot of the completed React Native Chat application showing a web interface with connection status, a message input field, realtime message display, and a presence indicator showing online users. The interface demonstrates the key features you'll build including publishing messages, subscribing to receive messages in realtime, and tracking which clients are currently present in the channel.](../../../../images/content/screenshots/getting-started/chat-react-native-getting-started-guide.png) + + ## Prerequisites ### Ably diff --git a/src/pages/docs/chat/getting-started/react-ui-kit.mdx b/src/pages/docs/chat/getting-started/react-ui-kit.mdx index cea08e6ee1..9c20feb008 100644 --- a/src/pages/docs/chat/getting-started/react-ui-kit.mdx +++ b/src/pages/docs/chat/getting-started/react-ui-kit.mdx @@ -10,6 +10,10 @@ This guide shows you how to add the Ably Chat React UI Kit to a brand-new React You'll create Ably clients, install the UI component package, and build a complete chat interface. You'll also cover customizing the look and feel with your own styles, settings, and avatars. + + ## Prerequisites 1. Sign up for an Ably account. diff --git a/src/pages/docs/chat/getting-started/react.mdx b/src/pages/docs/chat/getting-started/react.mdx index 041442bd72..6091cb1603 100644 --- a/src/pages/docs/chat/getting-started/react.mdx +++ b/src/pages/docs/chat/getting-started/react.mdx @@ -10,6 +10,10 @@ You'll learn how to create chat rooms, send and edit messages, and implement rea ![Screenshot of the completed React Chat application showing a web interface with connection status, a message input field, realtime message display, and a presence indicator showing online users. The interface demonstrates the key features you'll build including publishing messages, subscribing to receive messages in realtime, and tracking which clients are currently present in the channel.](../../../../images/content/screenshots/getting-started/chat-react-getting-started-guide.png) + + ## Prerequisites ### Ably diff --git a/src/pages/docs/chat/getting-started/swift-async-sequence.mdx b/src/pages/docs/chat/getting-started/swift-async-sequence.mdx index 03089809c3..639ca17881 100644 --- a/src/pages/docs/chat/getting-started/swift-async-sequence.mdx +++ b/src/pages/docs/chat/getting-started/swift-async-sequence.mdx @@ -10,6 +10,10 @@ You'll learn how to create chat rooms, send and edit messages, and implement rea ![Screenshot of the completed Swift Chat application showing a web interface with connection status, a message input field, realtime message display, and a presence indicator showing online users. The interface demonstrates the key features you'll build including publishing messages, subscribing to receive messages in realtime, and tracking which clients are currently present in the channel.](../../../../images/content/screenshots/getting-started/chat-swift-getting-started-guide.png) + + ## Prerequisites ### Ably diff --git a/src/pages/docs/chat/getting-started/swift.mdx b/src/pages/docs/chat/getting-started/swift.mdx index 36b0252268..3a5c115b71 100644 --- a/src/pages/docs/chat/getting-started/swift.mdx +++ b/src/pages/docs/chat/getting-started/swift.mdx @@ -10,6 +10,10 @@ You'll learn how to create chat rooms, send and edit messages, and implement rea ![Screenshot of the completed Swift Chat application showing a web interface with connection status, a message input field, realtime message display, and a presence indicator showing online users. The interface demonstrates the key features you'll build including publishing messages, subscribing to receive messages in realtime, and tracking which clients are currently present in the channel.](../../../../images/content/screenshots/getting-started/chat-swift-getting-started-guide.png) + + ## Prerequisites ### Ably diff --git a/src/pages/docs/getting-started/dotnet.mdx b/src/pages/docs/getting-started/dotnet.mdx index c235dd4ec1..761f41329f 100644 --- a/src/pages/docs/getting-started/dotnet.mdx +++ b/src/pages/docs/getting-started/dotnet.mdx @@ -10,6 +10,10 @@ This guide will get you started with Ably Pub/Sub in C# .NET. You'll establish a realtime connection to Ably and learn to publish and subscribe to messages. You'll also implement presence to track other online clients, and learn how to retrieve message history. + + ## Prerequisites 1. [Sign up](https://ably.com/sign-up) for an Ably account. diff --git a/src/pages/docs/getting-started/flutter.mdx b/src/pages/docs/getting-started/flutter.mdx index c3c4a5ccf3..39bb03f02e 100644 --- a/src/pages/docs/getting-started/flutter.mdx +++ b/src/pages/docs/getting-started/flutter.mdx @@ -12,6 +12,10 @@ You'll establish a realtime connection to Ably and learn to publish and subscrib ![Screenshot of the completed Flutter Pub/Sub application showing a web interface with connection status, a message input field, realtime message display, and a presence indicator showing online users. The interface demonstrates the key features you'll build including publishing messages, subscribing to receive messages in realtime, and tracking which clients are currently present in the channel.](../../../images/content/screenshots/getting-started/pub-sub-flutter-getting-started-guide.png) + + ## Prerequisites 1. [Sign up](https://ably.com/sign-up) for a free Ably account. diff --git a/src/pages/docs/getting-started/go.mdx b/src/pages/docs/getting-started/go.mdx index 092eeb208d..033b97750b 100644 --- a/src/pages/docs/getting-started/go.mdx +++ b/src/pages/docs/getting-started/go.mdx @@ -8,6 +8,10 @@ This guide will get you started with Ably Pub/Sub in Go. You'll establish a realtime connection to Ably and learn to publish and subscribe to messages. You'll also implement presence to track other online clients, and learn how to retrieve message history. + + ## Prerequisites 1. [Sign up](https://ably.com/signup) for an Ably account. diff --git a/src/pages/docs/getting-started/index.mdx b/src/pages/docs/getting-started/index.mdx index 3bfc41c640..eb29dce915 100644 --- a/src/pages/docs/getting-started/index.mdx +++ b/src/pages/docs/getting-started/index.mdx @@ -15,6 +15,10 @@ You'll learn the basics, such as how to connect to Ably, publish and subscribe t These are your first steps towards building a realtime application that can effortlessly scale to serve millions of users. + + {[ { diff --git a/src/pages/docs/getting-started/java.mdx b/src/pages/docs/getting-started/java.mdx index c5cc497dff..b5c2d1130d 100644 --- a/src/pages/docs/getting-started/java.mdx +++ b/src/pages/docs/getting-started/java.mdx @@ -10,6 +10,10 @@ This guide will get you started with Ably Pub/Sub in Java. You'll establish a realtime connection to Ably and learn to publish and subscribe to messages. You'll also implement presence to track other online clients, and learn how to retrieve message history. + + ## Prerequisites 1. [Sign up](https://ably.com/sign-up) for an Ably account. diff --git a/src/pages/docs/getting-started/javascript.mdx b/src/pages/docs/getting-started/javascript.mdx index 0300e7e89c..53ac625669 100644 --- a/src/pages/docs/getting-started/javascript.mdx +++ b/src/pages/docs/getting-started/javascript.mdx @@ -8,6 +8,10 @@ This guide will get you started with Ably Pub/Sub in JavaScript. You'll establish a realtime connection to Ably and learn to publish and subscribe to messages. You'll also implement presence to track other online clients, and learn how to retrieve message history. + + ## Prerequisites 1. [Sign up](https://ably.com/signup) for an Ably account. diff --git a/src/pages/docs/getting-started/kotlin.mdx b/src/pages/docs/getting-started/kotlin.mdx index d9e5df9b0a..33d6ff96e7 100644 --- a/src/pages/docs/getting-started/kotlin.mdx +++ b/src/pages/docs/getting-started/kotlin.mdx @@ -8,6 +8,10 @@ This guide will get you started with Ably Pub/Sub in Kotlin. You'll establish a realtime connection to Ably and learn to publish and subscribe to messages. You'll also implement presence to track other online clients, and learn how to retrieve message history. + + ## Prerequisites 1. [Sign up](https://ably.com/signup) for an Ably account. diff --git a/src/pages/docs/getting-started/laravel.mdx b/src/pages/docs/getting-started/laravel.mdx index 42667c2ba3..ff12f05a7b 100644 --- a/src/pages/docs/getting-started/laravel.mdx +++ b/src/pages/docs/getting-started/laravel.mdx @@ -10,6 +10,10 @@ You'll learn how to create a client and establish a connection to Ably using the ![Screenshot of the completed Laravel Pub/Sub application showing a web interface with a message input field and realtime message display. The interface demonstrates the key features you'll build including publishing messages and subscribing to receive messages in realtime.](../../../images/content/screenshots/getting-started/pub-sub-laravel-getting-started-guide.png) + + ## Prerequisites 1. [Sign up](https://ably.com/signup) for an Ably account. diff --git a/src/pages/docs/getting-started/node.mdx b/src/pages/docs/getting-started/node.mdx index 2bc3d5a7e7..57798654fa 100644 --- a/src/pages/docs/getting-started/node.mdx +++ b/src/pages/docs/getting-started/node.mdx @@ -8,6 +8,10 @@ This guide will get you started with Ably Pub/Sub in Node.js. You'll establish a realtime connection to Ably and learn to publish and subscribe to messages. You'll also implement presence to track other online clients, and learn how to retrieve message history. + + ## Prerequisites 1. [Sign up](https://ably.com/signup) for an Ably account. diff --git a/src/pages/docs/getting-started/objective-c.mdx b/src/pages/docs/getting-started/objective-c.mdx index d1d3f41d19..ecd74e72c8 100644 --- a/src/pages/docs/getting-started/objective-c.mdx +++ b/src/pages/docs/getting-started/objective-c.mdx @@ -14,6 +14,10 @@ This guide will get you started with Ably Pub/Sub in Objective-C. You'll establish a realtime connection to Ably and learn to publish and subscribe to messages. You'll also implement presence to track other online clients, and learn how to retrieve message history. + + ## Prerequisites 1. [Sign up](https://ably.com/sign-up) for an Ably account. diff --git a/src/pages/docs/getting-started/php.mdx b/src/pages/docs/getting-started/php.mdx index dc8b0d900a..017a1f9844 100644 --- a/src/pages/docs/getting-started/php.mdx +++ b/src/pages/docs/getting-started/php.mdx @@ -14,6 +14,10 @@ You'll learn how to connect to Ably using the REST SDK, generate JWTs for client This guide covers the Ably PHP SDK which provides RESTful functionality for publishing messages, retrieving history, and checking presence. If you need realtime features like subscribing to channels and receiving live updates, check out the [Ably Laravel broadcaster](https://github.com/ably/laravel-broadcaster) which integrates with Laravel's broadcasting system. + + ## Prerequisites 1. [Sign up](https://ably.com/signup) for an Ably account. diff --git a/src/pages/docs/getting-started/python.mdx b/src/pages/docs/getting-started/python.mdx index 85e63129eb..ebf7c0ad33 100644 --- a/src/pages/docs/getting-started/python.mdx +++ b/src/pages/docs/getting-started/python.mdx @@ -10,6 +10,10 @@ This guide will get you started with Ably Pub/Sub in Python. You'll establish a realtime connection to Ably and learn to publish and subscribe to messages. You'll also implement presence to track other online clients, and learn how to retrieve message history. + + ## Prerequisites 1. [Sign up](https://ably.com/signup) for an Ably account. diff --git a/src/pages/docs/getting-started/react-native.mdx b/src/pages/docs/getting-started/react-native.mdx index bc49ab67c2..2b6da0337e 100644 --- a/src/pages/docs/getting-started/react-native.mdx +++ b/src/pages/docs/getting-started/react-native.mdx @@ -12,6 +12,10 @@ You'll establish a realtime connection to Ably and learn to publish and subscrib ![Screenshot of the completed React Native Pub/Sub application showing a web interface with connection status, a message input field, realtime message display, and a presence indicator showing online users. The interface demonstrates the key features you'll build including publishing messages, subscribing to receive messages in realtime, and tracking which clients are currently present in the channel.](../../../images/content/screenshots/getting-started/pub-sub-react-native-getting-started-guide.png) + + ## Prerequisites 1. [Sign up](https://ably.com/sign-up) for a free Ably account. diff --git a/src/pages/docs/getting-started/react.mdx b/src/pages/docs/getting-started/react.mdx index 5b465a54be..cdb6957441 100644 --- a/src/pages/docs/getting-started/react.mdx +++ b/src/pages/docs/getting-started/react.mdx @@ -12,6 +12,10 @@ You'll establish a realtime connection to Ably and learn to publish and subscrib ![Screenshot of the completed React Pub/Sub application showing a web interface with connection status, a message input field, realtime message display, and a presence indicator showing online users. The interface demonstrates the key features you'll build including publishing messages, subscribing to receive messages in realtime, and tracking which clients are currently present in the channel.](../../../images/content/screenshots/getting-started/pub-sub-react-getting-started-guide.png) + + ## Prerequisites 1. [Sign up](https://ably.com/signup) for an Ably account. diff --git a/src/pages/docs/getting-started/ruby.mdx b/src/pages/docs/getting-started/ruby.mdx index 608c0a72b4..78e27cfbaf 100644 --- a/src/pages/docs/getting-started/ruby.mdx +++ b/src/pages/docs/getting-started/ruby.mdx @@ -10,6 +10,10 @@ This guide will get you started with Ably Pub/Sub in a new Ruby application. You'll establish a realtime connection to Ably and learn to publish and subscribe to messages. You'll also implement presence to track other online clients, and learn how to retrieve message history. + + ## Prerequisites 1. [Sign up](https://ably.com/sign-up) for an Ably account. diff --git a/src/pages/docs/getting-started/swift.mdx b/src/pages/docs/getting-started/swift.mdx index 2b33c2d6e3..a52ab93712 100644 --- a/src/pages/docs/getting-started/swift.mdx +++ b/src/pages/docs/getting-started/swift.mdx @@ -8,6 +8,10 @@ This guide will get you started with Ably Pub/Sub in a new Swift application bui You'll establish a realtime connection to Ably and learn to publish and subscribe to messages. You'll also implement presence to track other online clients, and learn how to retrieve message history. + + ## Prerequisites 1. [Sign up](https://ably.com/signup) for an Ably account. diff --git a/src/pages/docs/platform/ai-llms/index.mdx b/src/pages/docs/platform/ai-llms/index.mdx index 94920a60b1..bcbf6932d3 100644 --- a/src/pages/docs/platform/ai-llms/index.mdx +++ b/src/pages/docs/platform/ai-llms/index.mdx @@ -10,6 +10,45 @@ Ably documentation is designed to be LLM-friendly, making it easy to use AI assi If you're building AI-powered applications, see the [AI Transport](/docs/ai-transport) documentation for purpose-built infrastructure covering token streaming, session management, and human-in-the-loop workflows. +## Agent skills + +[Ably Agent Skills](https://github.com/ably/agent-skills) are packaged knowledge files that plug directly into AI coding agents such as Claude Code, Cursor, Copilot, and Windsurf. They teach your agent how to use Ably correctly, covering product selection, authentication patterns, common pitfalls, and debugging workflows. + +### Install in Claude Code + +Add the Ably plugin marketplace and install the plugin: + + +```shell +claude plugin marketplace add ably/agent-skills +claude plugin install ably@ably-agent-skills +``` + + +You can also run these as slash commands from within a Claude Code session: + + +```shell +/plugin marketplace add ably/agent-skills +/plugin install ably@ably-agent-skills +``` + + +### Install in other AI coding agents + +For Cursor, Copilot, Windsurf, Gemini CLI, and other supported agents, use the cross-agent [skills CLI](https://agentskills.io): + + +```shell +npx skills add ably/agent-skills +``` + + +Two skills are included: + +- The `using-ably` skill guides code generation with product and SDK selection, authentication, React integration, and a post-generation validation checklist. It automatically fetches current docs from `llms.txt` before generating code. +- The `debugging-with-ably-cli` skill provides diagnostic decision trees for common issues such as messages not arriving, auth errors, and connection failures. It teaches your agent to use the [Ably CLI](https://github.com/ably/cli) for debugging. + ## Available resources Ably provides two key resources optimized for LLM consumption: @@ -36,9 +75,9 @@ https://ably.com/llms.txt Use this file to help your LLM discover relevant documentation pages. -## LLM configuration prompt +## Manual LLM configuration prompt -Copy the following prompt into your `CLAUDE.md`, `AGENTS.md`, Cursor rules, or other LLM configuration file to help AI assistants navigate Ably documentation effectively. This prompt uses less than 1600 tokens, accounting for ~0.8% of a typical 200k context window. +If you prefer not to use Agent Skills, or your AI tool doesn't support plugins, you can manually add the following prompt to your `CLAUDE.md`, `AGENTS.md`, Cursor rules, or other LLM configuration file. This prompt uses less than 1600 tokens, accounting for ~0.8% of a typical 200k context window. ```text