Skip to content

docs: update readme, agents.md and docs folder#280

Merged
jesseturner21 merged 1 commit into
mainfrom
docs-update
Feb 11, 2026
Merged

docs: update readme, agents.md and docs folder#280
jesseturner21 merged 1 commit into
mainfrom
docs-update

Conversation

@notgitika

Copy link
Copy Markdown
Contributor

Description

Documentation updates

Related Issues

Documentation PR

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Other (please describe):

Testing

How have you tested the change?

  • I ran npm run test:all
  • I ran npm run typecheck
  • I ran npm run lint
  • If I modified src/assets/, I ran npm run test:update-snapshots and committed the updated snapshots

Checklist

  • I have read the CONTRIBUTING document
  • I have added any necessary tests that prove my fix is effective or my feature works
  • I have updated the documentation accordingly
  • I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the
terms of your choice.

@notgitika notgitika requested a review from a team February 11, 2026 19:59
@github-actions

Copy link
Copy Markdown
Contributor

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 8.32% 532 / 6392
🔵 Statements 7.99% 543 / 6793
🔵 Functions 5.61% 73 / 1300
🔵 Branches 6.14% 230 / 3743
Generated in workflow #291 for commit 6c0a4a0 by the Vitest Coverage Report Action

@jesseturner21 jesseturner21 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.

yum yum

@jesseturner21 jesseturner21 merged commit c76fc6c into main Feb 11, 2026
14 checks passed
@jesseturner21 jesseturner21 deleted the docs-update branch February 11, 2026 20:05
@agentcore-cli-automation

Copy link
Copy Markdown

Heads-up: this PR is already merged, but a couple of issues from it are still present in main and worth a follow-up. Some other concerns I had (e.g. dropping --target, --check, Container/VPC, Python 3.14, EPISODIC) appear to have been corrected by subsequent PRs (#697, #837, #898), so I'm only flagging what's still broken.

1. docs/memory.md — the new Python example in step 4 is broken

The replacement code block introduced in this PR (around lines 109–143 of the diff, current docs/memory.md lines ~111–138) has several real problems and won't work as written:

def agent_factory():
  cache = {}
    def get_or_create_agent(session_id, user_id):   # IndentationError — 4 spaces inside a 2-space block
      ...
      return cache[key]
    return get_or_create_agent                      # this is inside get_or_create_agent, not agent_factory
get_or_create_agent = agent_factory()

@app.entrypoint
async def invoke(payload, context):
  ...
  agent = get_or_create_agent(session_id, user_id)
  session_manager = get_memory_session_manager(session_id, user_id)

  agent = Agent(                                    # immediately overwrites the cached agent,
    model=load_model(),                             # defeating the whole point of the factory
    session_manager=session_manager,  # Add this line
    ...                                             # bare ellipsis left in code
  )

Concretely:

  • Indentation is invalid Python. cache = {} is at 2 spaces but def get_or_create_agent is at 4 spaces inside the same def agent_factory() body. return get_or_create_agent is also indented under get_or_create_agent rather than under agent_factory, so it self-references before it exists.
  • agent is reassigned right after being fetched from the factory, replacing the cached Agent(...) with a fresh one on every invocation. Either delete the second agent = Agent(...) block or delete the get_or_create_agent call — they're contradictory.
  • The bare ... token left in the second Agent(...) call would actually evaluate to Ellipsis and almost certainly isn't what's intended.

The previous version of this snippet (a simple @app.entrypoint with a single Agent(...) construction) was correct; if a caching factory is desired, it should be rewritten as a separate, fully-formed example.

2. docs/frameworks.md — BYO language list is too narrow

This PR changed the BYO documentation to claim --language only accepts Python:

3. **Language**: Python
...
| `--language <lang>`      | `Python`                                   |

But the CLI option help in src/cli/primitives/AgentPrimitive.tsx:218 still advertises:

'Language: Python (create), or Python/TypeScript/Other (BYO) [non-interactive]'

and TargetLanguageSchema in the constructs package is still z.enum(['Python', 'TypeScript', 'Other']). Either the docs should be restored to mention Python | TypeScript | Other for BYO, or the CLI option / schema should be narrowed to match the docs — but the two need to agree.

@agentcore-cli-automation agentcore-cli-automation left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Posted detailed feedback in a PR comment. Two issues from this PR are still in main: (1) the new Python code block in docs/memory.md step 4 has invalid indentation, an immediate reassignment of agent that defeats the new caching factory, and a bare ... token; (2) docs/frameworks.md claims BYO --language only accepts Python, but the CLI option and TargetLanguageSchema still support Python | TypeScript | Other. Other concerns I had appear to have been addressed by follow-up PRs.

@github-actions

Copy link
Copy Markdown
Contributor

Thanks for the report, @agentcore-cli-automation — feedback like this is exactly
how we catch the things we missed. Because this PR is already
closed, the team won't see follow-up comments here.

Would you mind opening a new issue so we can track it properly?
https://github.com/aws/agentcore-cli/issues/new/choose

If this is a security issue, please report it privately via
https://aws.amazon.com/security/vulnerability-reporting/ instead
of a public issue.

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.

3 participants