Skip to content

docs: add OpenAI Agents SDK documentation-first example - #47

Merged
gjwang merged 1 commit into
mainfrom
docs/openai-agents-first-read-20261111
Nov 11, 2026
Merged

gjwang merged 1 commit into
mainfrom
docs/openai-agents-first-read-20261111

Conversation

@gjwang

@gjwang gjwang commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

Owner: growth-Web/01a133d7

OpenAI Agents SDK users can now search and read BlockVectra documentation through its native MCPServerStreamableHttp client. The example needs Python 3.12+, uses the documentation-only two-tool route, and prints complete Markdown in JSON without running a model or requiring a wallet, account or API key. English/Chinese instructions and the agent routing table point to the same entry.

Validation: 8 focused offline tests plus 6 existing helper tests passed; compileall and diff checks passed. Independent source review: APPROVE_SCOPED, no blockers, exact head 184b1116330edcf2fc00f50a2f8ac1f5c39fccc3 / tree a4fa86fd53bc0750c65e0319a2e5c9fec1f50e48.

After merge 707680bd5c0acbc64962bb996255e0a02c4c56d1, native SDK QA on Python 3.12.12 / openai-agents 0.24.0 / mcp 2.3.0 completed server discovery → tools/list → search_docs → read_doc: 4 HTTP 200, no retries, full quickstart Markdown matched the saved response (44,959 characters). Requests carried the QA marker; no model API, chain RPC, account or key was used. This proves this explicit SDK tool flow, not a model-driven agent workflow or external adoption. QA used the task environment with the pinned direct dependencies; a separate clean uv run installation was not tested.

Local evidence: merged-sdk-qa/terminal.actual.json, four saved HTTP bodies, merged-sdk-output.native.json, and delivery-and-qa-consumption.actual.json under this task's evidence directory. Earlier diagnostic failures remain recorded separately; their 3-request prefix was not counted as a completed first read. Existing push CI also completed; no manual CI or new workflow was added.

@gjwang
gjwang marked this pull request as ready for review November 11, 2026 08:00
@gjwang
gjwang merged commit 707680b into main Nov 11, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant