Skip to content

docs(agentmesh): fix quickstart scaffold commands - #2114

Merged
Imran Siddique (imran-siddique) merged 1 commit into
microsoft:mainfrom
SomeshZanwar:docs/verify-agentmesh-tutorial-1643
May 12, 2026
Merged

Imran Siddique (imran-siddique) merged 1 commit into
microsoft:mainfrom
SomeshZanwar:docs/verify-agentmesh-tutorial-1643

Conversation

@SomeshZanwar

Copy link
Copy Markdown
Contributor

Summary

Fixes the AgentMesh quickstart scaffold path after verifying the tutorial end-to-end for #1643.

While running the AgentMesh quickstart on Windows, I found that the documented and generated commands no longer matched the current CLI/API behavior.

What changed

  • Updated the AgentMesh docs quickstart to use the generated project flow:
    • cd my-agent
    • python src/main.py
  • Removed the stale agentmesh run command from the quickstart path.
  • Updated the generated src/main.py scaffold to use AgentMeshClient, which is part of the current public API.
  • Updated the generated dependency from agentmesh>=1.0.0 to agentmesh-platform>=3.5.0.
  • Removed pip install -e . from the generated next steps because the scaffold is not structured as an installable Hatch package.

Verification

Tested the patched scaffold locally:

python -m agentmesh.cli.main init --name patched-agent --sponsor alice@company.com
cd patched-agent
python src/main.py

Output:

Agent DID: did:mesh:...
Initial trust score: 500
Decision: allow
Allowed: True
Updated trust score: 510.0

Also ran:

git diff --check
python -m py_compile agent-governance-python/agent-mesh/src/agentmesh/cli/main.py
findstr /S /I /N /C:"agentmesh run" docs\packages\agent-mesh.md agent-governance-python\agent-mesh\src\agentmesh\cli\main.py

No whitespace errors, compile errors, or remaining agentmesh run references in the touched files.

Closes #1643.

@github-actions

Copy link
Copy Markdown

Welcome to the Agent Governance Toolkit! Thanks for your first pull request.
Please ensure tests pass, code follows style (ruff check), and you have signed the CLA.
See our Contributing Guide.

@github-actions github-actions Bot added documentation Improvements or additions to documentation agent-mesh agent-mesh package labels May 12, 2026
@github-actions

Copy link
Copy Markdown
🤖 AI Agent: docs-sync-checker — Docs Sync

Docs Sync

  • README.md -- quickstart section needs update to reflect changes in scaffold commands and removed agentmesh run.
  • CHANGELOG.md -- missing entry for updated quickstart scaffold commands and behavioral changes in the generated project flow.

@github-actions github-actions Bot added the size/M Medium PR (< 200 lines) label May 12, 2026
@github-actions

Copy link
Copy Markdown
🤖 AI Agent: code-reviewer — View details

TL;DR: 0 blockers, 1 warning. Documentation and scaffold updates are accurate but require a minor follow-up.

# Sev Issue Where
1 Warn Update other docs referencing agentmesh run Potentially other docs in the repo

Action items: None.

Warnings:

# Issue Fine as follow-up PRs
1 Update other docs referencing agentmesh run Yes

@github-actions

Copy link
Copy Markdown
🤖 AI Agent: test-generator — View details

Test coverage looks good. No gaps identified.

@github-actions

Copy link
Copy Markdown
🤖 AI Agent: security-scanner — View details

No security issues found.

@github-actions

Copy link
Copy Markdown
🤖 AI Agent: breaking-change-detector — API Compatibility

API Compatibility

Severity Change Impact
Breaking Removed agentmesh run command from CLI Users relying on the run command will encounter errors.
Breaking Updated dependency from agentmesh>=1.0.0 to agentmesh-platform>=3.5.0 Potential incompatibility with existing projects using the previous version.
Breaking Changed from using AgentMesh to AgentMeshClient in the scaffold Changes the instantiation and usage pattern, breaking existing code that relies on the previous API.
Breaking Changed "Policy enforcement" to "Policy evaluation" in documentation May cause confusion or misinterpretation of functionality.

@github-actions

Copy link
Copy Markdown

PR Review Summary

Check Status Details
🔍 Code Review ⚠️ Warning See details
🛡️ Security Scan ✅ Passed No issues found
🔄 Breaking Changes ✅ Completed Analysis complete
📝 Docs Sync ✅ Completed Analysis complete
🧪 Test Coverage ✅ Completed Analysis complete

Verdict: ⚠️ Ready for human review

@SomeshZanwar

Copy link
Copy Markdown
Contributor Author

@microsoft-github-policy-service agree

@imran-siddique
Imran Siddique (imran-siddique) merged commit 82bcf24 into microsoft:main May 12, 2026
13 of 14 checks passed
@SomeshZanwar
Somesh Zanwar (SomeshZanwar) deleted the docs/verify-agentmesh-tutorial-1643 branch May 12, 2026 05:10
MohammadHaroonAbuomar pushed a commit to MohammadHaroonAbuomar/agt-acs that referenced this pull request Jun 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

agent-mesh agent-mesh package documentation Improvements or additions to documentation size/M Medium PR (< 200 lines)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

verify: run AgentMesh tutorial end-to-end and document issues

2 participants