Skip to content

docs(examples): update v2 example class references#2209

Open
mroldx wants to merge 2 commits into
agentscope-ai:mainfrom
mroldx:main
Open

docs(examples): update v2 example class references#2209
mroldx wants to merge 2 commits into
agentscope-ai:mainfrom
mroldx:main

Conversation

@mroldx

@mroldx mroldx commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

AgentScope-Java Version

2.0.0

Description

Update the examples README to match the current AgentScope Java 2.0 source structure.

Changes include:

  • Update example main class package names to io.agentscope.examples.documentation2.
  • Replace the removed HookExample with CustomizedMiddlewareExample.
  • Replace the renamed SessionExample with StateExample.
  • Replace the former combined McpToolExample with the current transport-specific examples:
    • McpStdioExample
    • McpSseExample
    • McpStreamableHttpExample
  • Document the environment variables required by the SSE and Streamable HTTP examples.

Verification

  • Confirmed that all referenced example classes exist.

  • Ran:

    mvn -pl agentscope-examples/documentation -am -DskipTests install

@mroldx mroldx requested a review from a team July 15, 2026 06:08

@AgentScopeJavaBot AgentScopeJavaBot left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 AI Review

This is a clean, focused documentation PR that updates agentscope-examples/README.md to align all example run commands, class references, and terminology with the AgentScope Java v2 source structure. All 11 class references were verified against the actual source tree and are correct. The PR re-parents all exec.mainClass paths from io.agentscope.examples.* to io.agentscope.examples.documentation2.<subpackage>.*, replaces removed/renamed examples, splits McpToolExample into transport-specific entries, and adds environment-variable documentation. Two minor pre-existing issues (duplicate section numbering and stale terminology) were carried forward.

(inline comments could not be attached — line numbers fell outside PR hunks. See archived report.)

@AgentScopeJavaBot AgentScopeJavaBot left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 AI Review

This is a clean, focused documentation PR that updates agentscope-examples/README.md to align all example run commands, class references, and terminology with the AgentScope Java v2 source structure. All 11 class references were verified against the actual source tree and are correct. The PR re-parents all exec.mainClass paths from io.agentscope.examples.* to io.agentscope.examples.documentation2.<subpackage>.*, replaces removed/renamed examples, splits McpToolExample into transport-specific entries, and adds environment-variable documentation. Two minor pre-existing issues (duplicate section numbering and stale terminology) were carried forward.

(inline comments could not be attached — line numbers fell outside PR hunks. See archived report.)

@AgentScopeJavaBot AgentScopeJavaBot added the area/examples agentscope-examples label Jul 16, 2026
@codecov

codecov Bot commented Jul 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/examples agentscope-examples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants