Contributing to Agent Governance Toolkit¶
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
How to Contribute¶
Reporting Issues¶
- Search existing issues before creating a new one
- Use the provided issue templates when available
- Include reproduction steps, expected behavior, and actual behavior
Pull Requests¶
- Fork the repository and create a feature branch from
main - Read the nearest
AGENTS.mdbefore changing code in that area - Make your changes in the appropriate package or top-level directory for that part of the repo
- Add or update tests as needed
- Ensure all tests pass:
pytest - Update documentation if your change affects public APIs
- Submit a pull request with a clear description of the changes
Repository Routing¶
This repo is a monorepo. Choosing the right path up front makes review much faster. The layout is also evolving: some language implementations now use standalone top-level directories at the repository root. For contributor routing, treat agent-governance-dotnet/ as the canonical .NET home and agent-governance-golang/ as the matching sibling pattern for Go. Treat the paths below as contributor-routing guidance rather than a promise that every legacy path remains the long- term home for that language.
| If your change is about... | Start here |
|---|---|
| Published first-party Python packages | agent-governance-python/ |
| Core governance/runtime behavior and Python apps | the repo root |
| Current shared SDK implementations | agent-governance-python/agent-mesh/sdks/ and other languages that still live in the shared layout |
| Standalone language implementations | agent-governance-python/, agent-governance-dotnet/, agent-governance-golang/, or other agent-governance-* siblings at the repository root |
| Tutorials, architecture, package docs | docs/ |
| Runnable framework integrations | examples/ |
| Interactive or live demos | examples/demos/ |
| Azure DevOps publishing/release automation | .github/pipelines/ |
| GitHub Actions, PR automation, templates | .github/ |
If a directory contains an AGENTS.md file, read it before you start. It captures local commands, boundaries, and review expectations for that area. If a standalone top-level language directory exists for the implementation you are changing, prefer that directory over an older shared path unless maintainers tell you to keep work in the legacy location. For published Python package work, contributor guidance should point to agent-governance-python/ as the canonical path. For the standalone .NET SDK, use agent-governance-dotnet/.
Choose the Smallest Correct Surface¶
- Prefer a docs update when the request is informational.
- Prefer an
examples/contribution when proving a new external integration. - Prefer
agent-governance-python/agentmesh-integrations/when the integration is reusable and maintained. - Propose a core package change only when the functionality clearly belongs in AGT long-term.
Attribution & Prior Art¶
All contributions must properly attribute prior work. This is a hard requirement, not a suggestion.
- If your contribution implements functionality similar to an existing open-source project, you must credit that project in your PR description and in code comments or documentation where the pattern is used.
- Copying or closely adapting architecture, API design, CLI conventions, or documentation from another project without attribution is not acceptable, even if the code is rewritten.
- When in doubt, cite the prior art. Over-attribution is always better than under-attribution.
- PRs found to contain uncredited derivatives of other open-source work will be closed.
Examples of what requires attribution: - Adapting a sandboxing approach from another security tool - Using an algorithm or protocol design described in another project's docs - Mirroring CLI flags, config schema, or architectural patterns from a known project
How to attribute: - In your PR description: list related projects under "Prior art / related projects" - In code: add a comment like # Approach adapted from <project> (<license>) - In documentation: include a "Prior art" or "Acknowledgments" section
External Integrations and Related Projects¶
We welcome integrations, but we review them as product decisions, not just code submissions.
- If you are proposing support for your own project, explain why AGT users benefit from it.
- Start with the smallest useful contribution shape: docs mention, example, integration package, then core-package change.
- Include adoption context when requesting a large integration surface. Small or brand-new projects are usually better introduced through examples than through core dependencies.
- New dependencies must be justified, pinned correctly, and appropriate for the part of the repo they are entering.
- "Related project" PRs may be closed if they read primarily as promotion rather than user value.
When in doubt, open an issue or discussion first and describe:
- the user problem
- the external project involved
- why the change belongs in AGT
- whether the first version can live in docs or examples
AI-Assisted Contributions¶
AI-assisted contributions are welcome, but they are held to the same standards as any other PR.
- Review, understand, and stand behind every line you submit.
- Verify that generated code and docs match the current repository state.
- Disclose meaningful AI assistance in the PR description when it materially shaped the change.
- Do not use AI to launder unattributed derivative work from other projects.
- Generated code still needs tests, docs updates, and security review where appropriate.
- Maintainers may ask contributors to narrow scope, split commits, or rewrite generated changes that are too broad or insufficiently understood.
Development Setup¶
# Clone the repository
git clone https://github.com/microsoft/agent-governance-toolkit.git
cd agent-governance-toolkit
# Install in development mode
pip install -e "agent-governance-python/agent-primitives[dev]"
pip install -e "agent-governance-python/agent-mcp-governance[dev]"
pip install -e "agent-os[dev]"
pip install -e "agent-mesh[dev]"
pip install -e "agent-runtime[dev]"
pip install -e "agent-sre[dev]"
pip install -e "agent-compliance[dev]"
pip install -e "agent-marketplace[dev]" # installs agentmesh-marketplace
pip install -e "agent-lightning[dev]"
pip install -e "agent-hypervisor[dev]"
pip install -e "agentmesh-integrations[dev]"
# Restore the standalone .NET SDK when working in that path
dotnet restore agent-governance-dotnet/AgentGovernance.sln
# Run tests
pytest
Docker Quickstart¶
If you prefer a containerized development environment, use the root Docker configuration. The image includes Python 3.11, Node.js 22, the core editable Python packages in this monorepo, and the TypeScript SDK dependencies.
# Build and start the development container
docker compose up --build dev -d
# Run the full test suite
docker compose run --rm test
To access the container and run commands interactively, use the following command:
The repository is bind-mounted into /workspace, so Python source changes are available immediately without rebuilding the image. If you update package metadata or dependency definitions, rebuild with docker compose build.
To launch the optional Agent Hypervisor dashboard:
Package Structure¶
This repo includes these core packages and standalone SDKs today:
| Package | Directory | Description |
|---|---|---|
agent-os-kernel | agent-governance-python/agent-os/ | Kernel architecture for policy enforcement |
agentmesh | agent-governance-python/agent-mesh/ | Inter-agent trust and identity mesh |
agentmesh-runtime | agent-governance-python/agent-runtime/ | Runtime sandboxing and capability isolation |
agent-sre | agent-governance-python/agent-sre/ | Observability, alerting, and reliability |
agent-governance | agent-governance-python/agent-compliance/ | Unified installer and runtime policy enforcement |
agentmesh-marketplace | agent-governance-python/agent-marketplace/ | Plugin lifecycle management for governed agent ecosystems |
agentmesh-lightning | agent-governance-python/agent-lightning/ | RL training governance with governed runners and policy rewards |
agent-hypervisor | agent-governance-python/agent-hypervisor/ | Runtime infrastructure and capability management |
agent-primitives | agent-governance-python/agent-primitives/ | Shared foundational Python primitives package |
agent-mcp-governance | agent-governance-python/agent-mcp-governance/ | Published MCP governance facade for Python consumers |
agent-governance-dotnet | agent-governance-dotnet/ | Standalone .NET SDK for agent governance |
agentmesh-integrations | agent-governance-python/agentmesh-integrations/ | Framework integrations and extension library |
Contributor routing for first-party published Python packages should use agent-governance-python/ at the repository root as the canonical path. The standalone .NET SDK should use agent-governance-dotnet/.
Coding Guidelines¶
- Follow PEP 8 for Python code
- Use type hints for all public APIs
- Write docstrings for all public functions and classes
- Keep commits focused and use conventional commit messages
Testing Policy¶
All contributions that add or change functionality must include corresponding tests:
- New features โ Add unit tests covering the primary use case and at least one edge case.
- Bug fixes โ Add a regression test that reproduces the bug before the fix.
- Security patches โ Add tests verifying the vulnerability is mitigated.
Tests are run automatically via CI on every pull request. The test matrix covers Python 3.10โ3.13 across the core packages in the repo root. PRs will not be merged until all required CI checks pass.
Run tests locally with:
Security¶
- Review the SECURITY.md file for vulnerability reporting procedures.
- Security scanning runs automatically on all PRs โ see docs/security-scanning.md for details
- Use
.security-exemptions.jsonto suppress false positives (requires justification) - Never commit secrets, credentials, or tokens.
- Use
--no-cache-dirfor pip installs in Dockerfiles. - Pin dependencies to specific versions in
pyproject.toml.
Merge Policy¶
All PRs from external contributors MUST be approved by a maintainer before merge. AI-only approvals and bot approvals do NOT satisfy this requirement.
This policy is enforced by: 1. CODEOWNERS โ every file requires review from @microsoft/agent-governance-toolkit 2. require-maintainer-approval.yml โ CI check that blocks merge without human maintainer approval 3. Branch protection โ CODEOWNERS review required on main
Why this policy exists: PRs #357 and #362 were auto-merged without maintainer review and reintroduced a command injection vulnerability (subprocess.run(shell=True)) that had been fixed for MSRC Case 111178 just days earlier. AI code review agents did not catch the security regression.
What counts as maintainer approval: - โ A GitHub "Approve" review from a listed CODEOWNER - โ AI/bot approval (Copilot, Sourcery, etc.) โ does not count - โ Author self-approval โ does not count - โ Admin bypass โ should not be used for external PRs
Security-sensitive paths (extra scrutiny required): - .github/workflows/ and .github/actions/ โ CI/CD configuration - Any file containing subprocess, eval, exec, pickle, shell=True - Trust, identity, and cryptography modules
Licensing¶
By contributing to this project, you agree that your contributions will be licensed under the MIT License.
Integration Author Guide¶
This guide walks you through creating a new framework integration for Agent Governance Toolkit โ from scaffolding to testing to publishing.
Integration Package Structure¶
Each integration is a standalone package under agent-governance-python/agentmesh-integrations/:
agent-governance-python/agentmesh-integrations/your-integration/
โโโ pyproject.toml # Package metadata and dependencies
โโโ README.md # Documentation with quick start
โโโ LICENSE # MIT License
โโโ your_integration/ # Source code
โ โโโ __init__.py
โ โโโ ...
โโโ tests/ # Test suite
โโโ __init__.py
โโโ test_your_integration.py
Key Interfaces to Implement¶
- VerificationIdentity: Cryptographic identity for agents
- TrustGatedTool: Wrap tools with trust requirements
- TrustedToolExecutor: Execute tools with verification
- TrustCallbackHandler: Monitor trust events
See agent-governance-python/agentmesh-integrations/langchain-agentmesh/ for the best reference implementation.
Writing Tests¶
- Mock external API calls and I/O operations
- Use existing fixtures from
conftest.pyif available - Cover primary use cases and edge cases
- Include integration tests for trust verification flows
Example test pattern:
def test_trust_gated_tool():
identity = VerificationIdentity.generate('test-agent')
tool = TrustGatedTool(mock_tool, required_capabilities=['test'])
executor = TrustedToolExecutor(identity=identity)
result = executor.invoke(tool, 'input')
assert result is not None
Optional Dependency Pattern¶
Implement graceful fallback when dependencies are not installed:
try:
import langchain_core
except ImportError:
raise ImportError(
"langchain-core is required. Install with: "
"pip install your-integration[langchain]"
)
PR Readiness Checklist¶
Before submitting your integration PR:
- [ ] Package follows the structure outlined above
- [ ]
pyproject.tomlincludes proper metadata (name, version, description, author) - [ ] README.md includes installation instructions and quick start
- [ ] All public APIs have docstrings
- [ ] Tests pass:
pytest your-integration/tests/ - [ ] Code follows PEP 8 and uses type hints
- [ ] No secrets or credentials committed
- [ ] Dependencies are pinned to specific versions
- [ ] Prior art and related projects are credited in the PR description
- [ ] The contribution shape is appropriate (example vs integration package vs core package)
Questions?¶
- Review existing integrations in
agent-governance-python/agentmesh-integrations/ - Open a discussion for design questions
- Tag
@microsoft/agent-governance-teamfor integration review
Data Model Conventions¶
@dataclassโ Use for internal value objects that don't cross serialization boundaries (policy rules, evaluation results, internal state).pydantic.BaseModelโ Use for models that cross serialization boundaries (API request/response models, configs loaded from YAML/JSON, manifests).- Don't mix โ within a single module, use one pattern consistently.