Repository navigation
WIP: Playbook developer docs - #4248
Closed
tylerhutcherson wants to merge 2 commits into
Closed
tylerhutcherson wants to merge 2 commits into
tylerhutcherson wants to merge 2 commits into
Conversation
|
|
Contributor
Contributor
🧠 Redis MemoryFound 5 related items from repository history (5 new this commit):
Memory updated at 51ddbf2 |
5 tasks
8 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Superseded by draft PR #4249 after the requested branch rename to
MOD-19391-playbook-developer-docs. The replacement preserves the commits, description, and open review items.Adds the Agent Playbooks developer docs under
/develop/ai/context-engine/agent-playbook/for docs-team and product review. The guides cover publishing a first FAQ, packaging skills, reviewing proposals and evidence, retrieving published entries, connecting an agent through MCP, and handling limits and errors.Concepts stays high level and links to the entry, version, proposal, and evidence models in the API reference. FAQ and skill examples produce distinct outcomes: finding refund status and drafting a customer reply from that status. Python snippets use normal indentation, and familiar acronyms stay concise (API, SDK, HTTP, FAQ, MCP, and URI).
The quickstart and skill guides include Python, TypeScript, and HTTP downloads generated from their displayed examples. Scoped CI checks the pinned public SDK contract, example execution, TypeScript compilation, and download drift. The shared API-reference template adds opt-in introduction rendering and a schema index; existing references retain their presentation. This PR does not create operator docs; the review handoff records future links using the existing Iris operator-docs pattern.
Validation
9f7f0da22), using Identity Service keys and real embeddings. Python, TypeScript, and hosted HTTP MCP produced the expected reply with a real model.Two open items for the developer docs
ClearPlaybook, while the current service returns 404 there and supports clearing through the control plane. The current alpha pins and contract remain intentional for this review; the guidance has a TODO for that alignment.Publication status
This is a draft, WIP PR. No publication gate is included, as requested. Merging to
mainautomatically publishes these pages to customers; draft status only prevents merging and does not hide content after a merge. Keep the PR unmerged until publication is approved. This repository and branch staging previews are public.