agent-canary 0.1.0__tar.gz

agent_canary-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,21 @@
+---
+name: Bug report
+about: Something isn't working correctly
+labels: bug
+---
+
+## Describe the bug
+
+## To reproduce
+
+```bash
+agent-canary [command you ran]
+```
+
+## Expected behavior
+
+## Environment
+
+* agent-canary version:
+* Python version:
+* OS:

agent_canary-0.1.0/.github/ISSUE_TEMPLATE/check_not_seen.md

@@ -0,0 +1,25 @@
+---
+name: Check not recognized
+about: A protection exists but agent-canary doesn't see it
+labels: check-not-seen
+---
+
+## Function flagged as "no checks" or "partial checks"
+
+**Function name**:
+**File**:
+**Line**:
+
+## The check that exists
+
+(describe where the protection is: in the same function, in a decorator, in function parameters, in a middleware, in an API gateway, etc.)
+
+## Code snippet
+
+```python
+(paste the function code AND the check code, even if in different files)
+```
+
+## Notes
+
+If the check is in a different file (middleware, gateway), the correct resolution is `# checked:ok — protected by [where]` in your source code. This issue template is for checks that ARE in the same function scope but agent-canary doesn't detect them.

agent_canary-0.1.0/.github/ISSUE_TEMPLATE/false_positive.md

@@ -0,0 +1,25 @@
+---
+name: False positive
+about: A function flagged that shouldn't be
+labels: false-positive
+---
+
+## Function flagged
+
+**Function name**:
+**File**:
+**Line**:
+
+## What agent-canary detected
+
+(paste the terminal output for this function)
+
+## Why it's a false positive
+
+(explain why this function doesn't actually change the real world, or why the detected "effect" is not a real side effect)
+
+## Code snippet
+
+```python
+(paste the function code)
+```

agent_canary-0.1.0/.github/ISSUE_TEMPLATE/missing_detection.md

@@ -0,0 +1,25 @@
+---
+name: Missing detection
+about: A tool call that should be detected but isn't
+labels: missing-detection
+---
+
+## Function missed
+
+**Function name**:
+**File**:
+**Line**:
+
+## What it does
+
+(describe the real-world effect: DB write, payment, email, etc.)
+
+## Code snippet
+
+```python
+(paste the function code)
+```
+
+## Expected detection
+
+(what category should it be: database_write, payment, http_write, etc.)

agent_canary-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+## What this PR does
+
+## Related issue
+
+Fixes #
+
+## Checklist
+
+- [ ] Tests added for new patterns/features
+- [ ] All tests pass (`python -m pytest tests/`)
+- [ ] No new external dependencies added to core

agent_canary-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,20 @@
+name: CI
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install -e ".[dev]"
+      - run: python -m pytest tests/ -v

agent_canary-0.1.0/.gitignore

@@ -0,0 +1,27 @@
+__pycache__/
+*.pyc
+*.pyo
+*.egg-info/
+dist/
+build/
+.eggs/
+*.egg
+.pytest_cache/
+.mypy_cache/
+.venv/
+venv/
+env/
+.env
+*.so
+.coverage
+htmlcov/
+
+# Internal research data
+data/
+*report*.json
+
+# Claude Code session
+.claude/
+
+# OS
+.DS_Store

agent_canary-0.1.0/AGENTS.md

@@ -0,0 +1,36 @@
+# AGENTS.md — for AI coding assistants
+
+## What this repo is
+
+agent-canary is a static analysis tool that scans Python codebases for tool calls (functions that change the real world: payments, database writes, HTTP calls, emails) and checks whether safety checks exist around them.
+
+## Architecture
+
+- `src/agent_canary/scanner/` — AST visitor that detects effects and checks
+- `src/agent_canary/scanner/patterns.py` — catalogue of all known patterns (data, not logic)
+- `src/agent_canary/analyzer/` — computes verdict (UNGUARDED / PARTIALLY_GUARDED / GUARDED / LOW_RISK) and missing check hints
+- `src/agent_canary/reporter/` — terminal, markdown, JSON, YAML registry outputs
+- `src/agent_canary/models.py` — dataclasses: SideEffect, Guard, Tool, Scenario, ScanResult
+- `src/agent_canary/cli.py` — argparse CLI entry point
+
+## Key design decisions
+
+- **AST, not regex.** We parse Python source with the stdlib `ast` module. Regex would miss nested calls and produce false positives on strings/comments.
+- **stdlib only.** Zero required dependencies. `rich` is optional for terminal color, `pyyaml` for YAML output.
+- **No inter-procedural analysis.** Each function is analyzed in isolation. This limits depth but keeps the scanner fast and predictable.
+- **Effects and checks, not risk scores.** The scanner reports what it sees. It does not assign severity or suggest fixes.
+
+## Running tests
+
+```bash
+PYTHONPATH=src python -m pytest tests/ -v
+```
+
+201 tests. All must pass before merge.
+
+## Conventions
+
+- Python 3.10+
+- `from __future__ import annotations` in all source files
+- No external dependencies in core scanner
+- Patterns are data in `patterns.py`, not logic scattered across the codebase

agent_canary-0.1.0/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+## 0.1.0 — 2026-03-23
+
+Initial release.
+
+- AST scanner detecting 11 effect categories and 7 check types in Python agents
+- Terminal, Markdown, JSON, and YAML registry output formats
+- `--fail-on-unchecked` CI gate (alias: `--fail-on-unguarded`) with baseline support
+- `# checked:ok` inline annotation for acknowledged tool calls
+- Benchmarked on Skyvern (382 findings), SurfSense (319), FinRobot (27)

agent_canary-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing to agent-canary
+
+## Quick start
+
+```bash
+git clone https://github.com/Diplomat-agents/agent-canary.git
+cd agent-canary
+pip install -e ".[dev]"
+python -m pytest tests/
+```
+
+## How to contribute
+
+### Report a false positive
+
+The most valuable contribution. Open an issue using the "False positive" template with the function code and the incorrect detection.
+
+### Report a missing tool call
+
+If agent-canary misses a function that changes the real world, open an issue with the "Missing detection" template.
+
+### Add a pattern
+
+Patterns are in `src/agent_canary/scanner/patterns.py`. Each pattern needs a test fixture in `tests/fixtures/` and a test in `tests/`.
+
+## Code style
+
+* No external dependencies in core (stdlib only)
+* `rich` and `pyyaml` are optional
+* Run `python -m pytest tests/` before submitting
+
+## Pull request process
+
+1. Fork and create a branch from `main`
+2. Add tests for new patterns
+3. Ensure all tests pass
+4. Open a PR with a clear description

agent_canary-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Diplomat Services SAS
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

agent_canary-0.1.0/PKG-INFO

@@ -0,0 +1,162 @@
+Metadata-Version: 2.4
+Name: agent-canary
+Version: 0.1.0
+Summary: Scan your agentic codebase for unguarded tool calls with real-world side effects
+Project-URL: Homepage, https://github.com/Diplomat-agents/agent-canary
+Project-URL: Repository, https://github.com/Diplomat-agents/agent-canary
+License: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.9
+Provides-Extra: all
+Requires-Dist: pyyaml>=6.0; extra == 'all'
+Requires-Dist: rich>=13.0; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: pyyaml>=6.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Provides-Extra: rich
+Requires-Dist: rich>=13.0; extra == 'rich'
+Provides-Extra: yaml
+Requires-Dist: pyyaml>=6.0; extra == 'yaml'
+Description-Content-Type: text/markdown
+
+![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue) ![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-green) ![Dependencies: 0](https://img.shields.io/badge/dependencies-0-brightgreen)
+
+# agent-canary
+
+Your agent can send emails, delete database rows, and charge credit cards — do you know which of those calls have no validation around them?
+
+agent-canary scans your Python codebase and maps every function that can change the real world. For each one, it tells you what safety checks exist — and what's missing.
+
+```
+$ agent-canary ./skyvern/
+382 tool calls · 307 with no checks · 66 partial · 9 confirmed
+
+⚠ terminate                 .../script_skyvern_page.py:868
+  actions:
+    shutil.rmtree(temp_dir)
+    os.kill(pid, signal.SIGTERM)
+  checks:  none
+
+⚠ _analyze_gmail_messages   .../composio_gmail_connector.py:228
+  actions:
+    session.execute(insert(messages))
+  checks:  none
+    → no auth check · no rate limit · no idempotency key
+
+~ session_create             .../browser.py:126
+  actions:
+    db.add(browser_session)
+    db.commit()
+  checks:
+    if not current_user: raise HTTPException(403)
+    → no rate limit
+
+✓ _get_or_create_browser_state  .../script_skyvern_page.py:81  [idempotency: full]
+```
+
+## The problem
+
+Your agent calls `stripe.Refund.create`, `session.commit`, `requests.post` — and nothing stops it from doing so twice, without auth, or with unbounded parameters. 1,075 GitHub issues across LangGraph, CrewAI, AutoGen, and OpenAI Agents SDK document tool calls executing multiple times without idempotency. 307 of 382 tool calls in Skyvern have no checks at all.
+
+## What it does
+
+Scans your Python source with AST analysis. No network calls. No config. No dependencies. Finds every function that triggers a real-world action (DB write, payment, email, API call, LLM invocation, file delete) and checks whether protections exist (auth, rate limit, validation, idempotency, retry bounds).
+
+## Quickstart
+
+```bash
+pip install agent-canary
+agent-canary ./my_agent/
+```
+
+Output in < 2 seconds. Zero dependencies. Try it on the included demo:
+
+```bash
+agent-canary examples/demo_agent/
+```
+
+## What gets flagged
+
+| Tool call | Why it's flagged |
+|-----------|-----------------|
+| `stripe.Refund.create(amount=amount)` | No bounds on `amount`, no rate limit, no idempotency key |
+| `session.commit()` in an agent tool | No auth check before the write |
+| `openai.chat.completions.create()` in a retry loop | No `max_retries` or `stop_after_attempt` — unbounded LLM spend |
+
+## CI integration
+
+```yaml
+- run: pip install agent-canary
+- run: agent-canary . --fail-on-unchecked --output-registry toolcalls.yaml
+```
+
+Exit code 1 if any new tool call has no checks. Existing unguarded calls are visible but don't block CI until you address them.
+
+## The registry
+
+```bash
+agent-canary . --format registry > toolcalls.yaml
+```
+
+Generates a YAML inventory of every tool call, its checks, and what's missing. Commit it to your repo. Diff it on PRs. Each entry can be signed off with `# checked:ok` — creating an auditable record of who reviewed what.
+
+This is what no other tool produces: a versionable, diffable artifact that tracks your agent's entire impact surface over time. See [`examples/toolcalls.skyvern.yaml`](examples/toolcalls.skyvern.yaml) for a real excerpt.
+
+## Benchmarked on real projects
+
+| Project | Stars | Tool calls | Unguarded | Time |
+|---------|------:|----------:|-----------:|-----:|
+| [Skyvern](https://github.com/Skyvern-AI/skyvern) | 20.9k | 382 | 307 (80%) | ~2s |
+| [SurfSense](https://github.com/MODSetter/SurfSense) | 13.3k | 319 | 169 (53%) | 1.4s |
+| [FinRobot](https://github.com/AI4Finance-Foundation/FinRobot) | 6.5k | 27 | 18 (67%) | <1s |
+
+## How to resolve findings
+
+| Action | How |
+|--------|-----|
+| **Fix** | Add validation in code. The next scan picks it up. |
+| **Acknowledge** | Add `# checked:ok` as a comment on the function. |
+| **Protected elsewhere** | Add `# checked:ok — protected by [middleware/gateway/etc]` |
+
+## What it detects
+
+**Tool calls:** `session.commit`, `db.add`, `stripe.Refund.create`, `requests.post`, `send_mail`, `openai.chat.completions.create`, `exec()`, `s3.put_object`, `os.remove`, `shutil.rmtree`
+
+**Checks:** `Depends()` / `Security()` (FastAPI), `@login_required`, `@rate_limit`, `get_or_create`, `Field(le=, ge=)`, `max_retries=`, `confirm` / `approve` in function body
+
+## Limitations
+
+- **Import aliases** — `import requests as req` then `req.post()` is not detected
+- **Cross-function analysis** — if the check is in the caller and the effect is in the callee, not detected
+- **Python only** — TypeScript planned
+
+## Why this exists
+
+We analyzed 3,047 GitHub issues across LangGraph, CrewAI, AutoGen, OpenAI Agents SDK, Claude Code, and Vercel AI SDK. 737 directly document tool calls executing without checks — duplicate executions, missing rate limits, loops without bounds, payments without validation.
+
+The most common pattern (1,075 issues): a tool call that executes multiple times when it should execute once. The cause: no idempotency, no rate limit, no circuit breaker in the code around the tool.
+
+agent-canary doesn't fix these problems. It makes them visible.
+
+See [methodology](docs/METHODOLOGY.md) for data sources and classification criteria.
+
+## Configuration
+
+For dynamic tools (MCP servers, plugins), create an `agent-canary.yml`:
+
+```yaml
+tools:
+  - name: search_web
+    effects: [http_write]
+  - name: send_slack
+    effects: [messaging]
+```
+
+## License
+
+Apache-2.0
+
+---
+
+Built by the team behind Diplomat — runtime governance for AI agents.