Skip to content

docs: Add SDK-first guidance to AGENTS.md and llms.txt - #5995

Closed
jam-jee wants to merge 2 commits into
aws:masterfrom
jam-jee:add-sdk-first-agent-guidance
Closed

jam-jee wants to merge 2 commits into
aws:masterfrom
jam-jee:add-sdk-first-agent-guidance

Conversation

@jam-jee

@jam-jee jam-jee commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator

What

Adds an SDK-first section to AGENTS.md and llms.txt (both merged earlier in #5982).

The prior files already steer agents from SDK v2 → v3. This change addresses a distinct
gap: when a task doesn't name the SDK (e.g. "generate training code for a SageMaker serverless
job"), agents often drop to raw boto3 (create_training_job/create_endpoint), the AWS CLI,
or a hand-rolled framework script instead of the SageMaker Python SDK.

Changes

  • New "SDK-first" guidance: for any SageMaker task, default to the SageMaker Python SDK v3 as
    the primary interface.
  • A natural-language intent → v3 interface table (train → ModelTrainer, deploy →
    ModelBuilder, process → ProcessingJob, pipeline → sagemaker.mlops, image →
    image_uris.retrieve).

Notes

Docs-only change (AGENTS.md, llms.txt); no SDK source touched.


X-AI-Prompt: Add SDK-first (library-selection) guidance so agents default to the SageMaker Python SDK v3 without an explicit nudge
X-AI-Tool: Kiro

jam-jee added 2 commits July 1, 2026 12:52
Add an AGENTS.md (agents.md convention) and llms.txt (llmstxt.org
convention) at the repo root so AI coding agents generate SageMaker
Python SDK v3 code by default instead of deprecated v2 code.

Both files carry a v3-by-default rule, a banned-v2-pattern to v3
replacement table grounded in migration.md, the
sagemaker-core/-train/-serve/-mlops module map, a contributor
workflow, and a self-check step before emitting code.

---
X-AI-Prompt: Create AGENTS.md and llms.txt for the SDK repo to steer AI agents to SageMaker Python SDK v3
X-AI-Tool: Kiro
Add an "SDK-first" section (with a natural-language intent -> v3 interface
table) so AI coding agents default to the SageMaker Python SDK v3 as the
primary interface for SageMaker tasks, rather than dropping to raw boto3
(create_training_job/create_endpoint), the AWS CLI, or hand-rolled framework
scripts.

---
X-AI-Prompt: Add SDK-first (library-selection) guidance so agents default to the SageMaker Python SDK v3 without an explicit nudge
X-AI-Tool: Kiro
@jam-jee

jam-jee commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator Author

Recreating from current upstream master so the diff shows only the incremental SDK-first additions (branch was based on the squash-merged #5982 and diverged).

@jam-jee jam-jee closed this Jul 7, 2026
@jam-jee
jam-jee deleted the add-sdk-first-agent-guidance branch July 7, 2026 20:25

This branch was previously deployed

1 inactive deployment
auto-approve — 27175e55 Deployed Jul 7, 2026 by jam-jee via wait-for-approval #884
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