docs(ai-chat): correct chat.agent reference drift

[ericallam]

Summary

Accuracy fixes across the AI chat docs: drop the non-existent per-call option from transport.preload, clarify that onValidateMessages only fires on turns carrying incoming messages, soften the turn-complete token-refresh wording (the header is optional), document the new onTurnComplete error field and finishReason, and correct the idle-timeout default to 30 seconds.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 22c64cd

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: eee80cee-25df-4ad0-b57c-f4df956cc2c8

📥 Commits

Reviewing files that changed from the base of the PR and between 5d114d0 and 22c64cd.

📒 Files selected for processing (1)

• docs/ai-chat/client-protocol.mdx

✅ Files skipped from review due to trivial changes (1)

• docs/ai-chat/client-protocol.mdx

📜 Recent review details

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

• GitHub Check: Analyze (actions)
• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: Mintlify Deployment

---

Walkthrough

This PR updates documentation across five AI chat API guides to reflect current implementation behavior. Changes clarify that turn completion events include an error field for errored turns (with potentially undefined or partial response messages), the optional nature of token refresh headers, idempotency header generation per logical send with retry reuse, default idle timeout as 30 seconds, preload transport signature accepting only chatId without per-call timeout options, and hook execution conditions that skip validation on turns without incoming messages.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description provides a clear summary of all changes made, but does not follow the repository's required template structure with checklist, testing, and changelog sections.	Add the required template sections including checklist confirmation, testing steps, and structured changelog entry to match the repository's pull request template.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main objective: correcting documentation accuracy issues across the AI chat module regarding the chat.agent reference implementation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/chat-agent-accuracy

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[mintlify]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated (UTC)
trigger	🟢 Ready	View Preview	Jun 10, 2026, 2:50 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

[devin-ai-integration]

Devin Review found 3 potential issues.

View 2 additional findings in Devin Review.