From 0ed5a7f363f3500fd5565c25432955c2465d9300 Mon Sep 17 00:00:00 2001 From: AssemblyAI Date: Fri, 29 May 2026 23:22:53 +1000 Subject: [PATCH] Project import generated by Copybara. GitOrigin-RevId: 00ba6e0af1f32416af0791e8ddde72f7cc14b621 --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 72154b7..3816076 100644 --- a/README.md +++ b/README.md @@ -25,9 +25,27 @@ With a single API call, get access to AI models built on the latest AI breakthro > request. See our [official documentation](https://www.assemblyai.com/docs) > for more information, including HTTP code examples. -## Claude Code +## Using with AI coding agents -This repository includes a [`CLAUDE.md`](CLAUDE.md) file that provides context to Claude Code about this SDK — key APIs, common patterns, and gotchas. When you open this repo in Claude Code, it automatically reads this file to give better assistance. +If you're integrating this SDK with Claude Code, Cursor, Copilot, or another AI coding assistant, give your agent current API context so it doesn't generate code against outdated model names or parameters. + +The most effective option is project instructions. Add this to your `CLAUDE.md`, `.cursorrules`, `AGENTS.md`, or equivalent agent instructions file: + +> Always fetch https://assemblyai.com/docs/llms.txt before writing AssemblyAI code. The API has changed, do not rely on memorized parameter names. + +For on-demand documentation lookups during a session, connect the AssemblyAI docs MCP server: + +``` +claude mcp add assemblyai-docs --transport http https://mcp.assemblyai.com/docs +``` + +For deep SDK context in Claude Code specifically, install the [AssemblyAI skill](https://github.com/AssemblyAI/assemblyai-skill): + +``` +claude install-skill https://github.com/AssemblyAI/assemblyai-skill +``` + +See [Coding agent prompts](https://www.assemblyai.com/docs/coding-agent-prompts) for Cursor setup, MCP tool details, and tips for best results. # Overview