Skip to content

Add ChatGPT plugin cookbook with the Agents SDK and Amazon Bedrock AgentCore - #3055

Closed
rohan-eliza wants to merge 1 commit into
openai:mainfrom
rohan-eliza:add-chatgpt-agents-sdk-agentcore-cookbook
Closed

Add ChatGPT plugin cookbook with the Agents SDK and Amazon Bedrock AgentCore#3055
rohan-eliza wants to merge 1 commit into
openai:mainfrom
rohan-eliza:add-chatgpt-agents-sdk-agentcore-cookbook

Conversation

@rohan-eliza

Copy link
Copy Markdown

Summary

Add a joint Eliza–OpenAI cookbook that connects ChatGPT to a private, read-only flight assistant using the OpenAI Agents SDK, an Amazon Bedrock model, Secure MCP Tunnel, and AgentCore observability.

The example lives under examples/partners/AWS/chatgpt_agents_sdk_aws_agentcore_cookbook/ and includes an executable notebook, Python agent, TypeScript MCP adapter, widget, supporting documentation, and locked dependencies. A registry entry makes the notebook discoverable on the Cookbook website.

This is the initial upstream submission. It incorporates the feedback tracked in eliza-hq/chatgpt-agents-sdk-aws-agentcore-cookbook#22 and the reviewed source update a259ad0. The source update contains the focused seven-file feedback diff; this PR includes the complete example because it is new to this repository.

Reviewer entry points: Notebook · Architecture diagram

Motivation

Teach readers how to expose validated tools to ChatGPT, connect a private tool server, run an Agents SDK workflow with Bedrock, and evaluate responses separately from checking trace delivery.

Review feedback How it is addressed
Lead with learning outcomes Open with what readers will learn. Identify Eliza Airlines as fictional and keep the joint contributor attribution separate.
Simplify the first diagram Show one default local request flow with readable labels. Explain optional Runtime hosting and dual tracing in the text.
Make the prose more natural Rewrite the notebook and matching documentation, including private Developer mode testing and public distribution requirements, while preserving the limitations.
Shorten code and explain terminology Extract process handling, service cleanup, and report plumbing into notebook_helpers.py; reduce the longest notebook cell from 246 to 32 lines. Keep the Agents SDK configuration and request/response examples visible, and explain terms when introduced.
Add a conclusion Recap the integration and explain how to replace the sample tools, update schemas and the widget, and adapt evaluation cases.

Upstream packaging preserves the reviewed notebook byte for byte. It clarifies the example-root working directory, links the standalone project's CI rather than installing a new workflow here, and adds the required registry entry.

Validation

  • Ran the repository's .github/scripts/check_notebooks.py: the added notebook is valid.
  • Validated registry.yaml against the repository JSON schema and checked local documentation links and anchors.
  • Executed the credential-free notebook from its upstream directory, including Python tests, Ruff/Pyright, MCP tests/build/type checks, the local HTTP example, and Promptfoo configuration validation.
  • Reviewed the rendered architecture diagram and completed the repository-local docs-editor pass.
  • Confirmed notebook metadata, cell IDs, outputs, execution counts, and code match the reviewed source.
  • Live AWS, Secure MCP Tunnel, ChatGPT, and credentialed agent-evaluation steps were not run. They remain explicit opt-ins for the remaining environment-specific review.

For new content

  • Added a new entry in registry.yaml. Author display uses the existing GitHub-profile fallback; authors.yaml is unchanged. The notebook retains the joint Eliza–OpenAI attribution.
  • Conducted a self-review based on the contribution guidelines:
    • Relevance: teaches an integration using the OpenAI Agents SDK and ChatGPT.
    • Uniqueness: complements the existing AWS model, AML, and AgentCore Payments examples with a private ChatGPT-to-MCP workflow.
    • Spelling and grammar: reviewed the notebook and supporting Markdown.
    • Clarity: learning outcomes, terminology, readable architecture, focused examples, and a conclusion are included.
    • Correctness: the default credential-free path executes successfully; live paths are gated and their validation limits are stated above.
    • Completeness: includes the source, dependencies, setup, access requirements, tests, evaluation guidance, and references needed to follow the example.

@rohan-eliza
rohan-eliza requested a review from a team as a code owner September 3, 2026 07:08
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-09-03T07:16:43.255387Z 922ad57 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@rohan-eliza
rohan-eliza marked this pull request as draft September 3, 2026 07:10
@rohan-eliza rohan-eliza closed this Sep 3, 2026
@rohan-eliza
rohan-eliza deleted the add-chatgpt-agents-sdk-agentcore-cookbook branch September 3, 2026 07:14

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 922ad57a5e

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +79 to +80
check "CloudWatch Transaction Search destination state" \
aws --no-cli-pager xray get-trace-segment-destination --region "$region" --output table

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Align preflight checks with the least-privilege role

In the documented standard local path, the developer receives only the publisher permissions listed in README.md line 107 and docs/aws-iam.md lines 39–82, but this mandatory preflight calls xray:GetTraceSegmentDestination and subsequently requires logs:DescribeResourcePolicies, logs:DescribeLogGroups, and servicequotas:ListServiceQuotas, none of which that role grants. Consequently, a correctly provisioned least-privilege user reaches step 5 and the script exits nonzero before the smoke test; either supply/document a separate preflight permission set or make these administrator-only checks optional.

Useful? React with 👍 / 👎.

In terminal 1:

```bash
cd /path/to/chatgpt-agents-sdk-aws-agentcore-cookbook

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P0 Badge Match the checked-in directory name in cd commands

Step 3 clones the example into examples/partners/AWS/chatgpt_agents_sdk_aws_agentcore_cookbook, but this command—and the repeated commands around lines 357 and 710—uses the nonexistent hyphenated directory chatgpt-agents-sdk-aws-agentcore-cookbook. A reader who replaces only /path/to as instructed cannot enter the example directory; use the checked-in underscore-separated name consistently.

AGENTS.md reference: AGENTS.md:L37-L38

Useful? React with 👍 / 👎.

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