mirror of https://github.com/ComposioHQ/composio.git synced 2026-09-22 11:46:35 +08:00

Files

T

Alberto Schiabel 2367b80d9d chore(ci): enforce agent guidance validators in CI (#4447 )

This PR:
- Add `.github/workflows/agent-substrate.yml` running `pnpm
validate:agent-skills` and `pnpm validate:skill-routing` on every push
and pull request; both validators previously ran in no CI workflow
- No path filters on the trigger: the stale-guidance walk scans every
text file in the repo, so any change can affect the result (PR runs
restore caches but only `next` pushes save them, per the
`setup-node-pnpm-bun` guidance)
- Skip `vendor/` directories in the `validate:agent-skills`
stale-guidance walk, which was failing on read-only third-party
snapshots mentioning other tools' rule conventions
- Extend the validator's command scan to `CONTRIBUTING.md` (with a `pnpm
dlx` exemption), so its documented commands are checked against
`package.json`, `python/Makefile`, and `python/noxfile.py` like the rest
of the guidance
- Point the routing-test header, root `AGENTS.md`, and
`skill-maintenance` reference docs at the new workflow, and add a
"Working with AI Coding Agents" section to `CONTRIBUTING.md` covering
the inherited agent setup, the two checks, and the routing-probe
requirement for skill edits

## Context

These two validators are the only checks keeping repo-level agent
guidance honest: command names mentioned in guidance are verified
against `package.json`, `python/Makefile`, and `python/noxfile.py`, and
routing probes assert each skill stays the unique top match for its
representative task. Until now nothing enforced either one, and the
stale-guidance walk was already red on vendored trees — a failure no
guidance owner could fix, which trains people to ignore the check. This
makes both checks blocking everywhere they can bite.

## Verification

- `pnpm validate:agent-skills` — 19 skills, green, now including
`CONTRIBUTING.md` commands
- `pnpm validate:skill-routing` — 19 probes over 19 skills, green
- Workflow YAML parsed; oxlint and prettier clean on touched files
- `Agent Substrate` workflow ran green on this PR (42s) before the
trigger change and re-runs on every push

2026-09-11 17:31:23 +02:00

4.9 KiB

Raw Permalink Blame History

AGENTS.md

Repository guidance for Codex, Claude Code, Cursor, pi.dev, and other AI coding agents.

Scope

This is the Composio SDK v3 monorepo. Most product code lives in ts/ and python/; docs live in docs/. Branch new work from next and target PRs at next unless the user says otherwise.

First Steps

Read the nearest nested AGENTS.md before editing a subtree.
Preserve unrelated dirty work. Do not revert, delete, or reformat files outside the requested scope.
Treat .agents/skills as the canonical local skill tree. .claude/skills is a compatibility symlink and must not be edited as a separate copy.
Do not edit generated SDK surfaces or vendor trees — see Generated And Vendored Paths.
Verify every command you write against the current package.json, Makefile, noxfile.py, or workflow file.

Skill Routing

Use the smallest relevant skill:

repo-guidance: repo layout, branch/PR workflow, changesets, generated files, or cross-repo maintenance.
skill-maintenance: adding or changing local skills, skill references, compatibility mirrors, or validation.
bug-fixing: fixing a defect and choosing regression tests.
cross-sdk-parity: aligning TypeScript and Python behavior, generated client bumps, or API contract drift.
docs-decisions: docs site work, changelogs, docs decisions, or docs automation.
good-docs-writing: drafting or revising docs prose in the house writing voice.
good-docs-audit: reviewing existing docs or prose against that voice and reporting violations.
eve: durable backend AI agents built with the eve framework.
typescript-sdk, typescript-testing, typescript-providers: TypeScript SDK/core/provider work.
cli-command, cli-e2e: CLI design/implementation or CLI end-to-end tests.
cli-release: first-party CLI beta builds, stable promotion, release verification, or recovery.
python-sdk, python-testing, python-providers, python-release: Python SDK/provider/testing/release work.

Repository Map

ts/                         TypeScript SDK workspace
  packages/core/            @composio/core
  packages/providers/       TypeScript provider adapters
  packages/cli/             Effect-based CLI
  e2e-tests/                Docker runtime and CLI E2E tests
python/                     Python SDK and provider packages
docs/                       Fumadocs documentation site
.agents/skills/             Canonical local agent skills
docs/agent-guidance/        Neutral docs-agent context and workflow instructions
docs/decisions/             Neutral docs decisions and ADR-style records

Generated And Vendored Paths

Do not hand-edit these. They are regenerated or vendored, and edits will be overwritten. They are also marked linguist-generated/linguist-vendored in .gitattributes.

ts/vendor/** — vendored read-only snapshots of Effect and Clack (git submodules); reference only.
ts/packages/cli-local-tools/vendor/** — vendored local-tool sources (git submodules).
ts/packages/core/generated/**, ts/packages/core/pack/generated/** — generated SDK surfaces produced by composio generate / the build pipeline.
pnpm-lock.yaml, uv.lock, **/bun.lock — package-manager lockfiles; change them by running the package manager, never by hand.

Common Commands

Use mise install for the pinned toolchain. pnpm is managed through mise, not Corepack.

pnpm install
pnpm build
pnpm build:packages
pnpm lint
pnpm format
pnpm typecheck
pnpm test
pnpm test:e2e
pnpm test:e2e:cli
pnpm validate:agent-skills
pnpm validate:skill-routing

Both validators are dependency-free and deterministic. .github/workflows/agent-substrate.yml runs them in CI on every push and pull request — the stale-guidance scan covers the whole repo, so any change can affect the result.

Python commands run from python/ unless otherwise noted:

make env
source .venv/bin/activate
make fmt
make chk
make tst
make snt
make build

Release And Package Notes

TypeScript package releases use Changesets. Add a changeset only when published TypeScript packages change.
@composio/cli and @composio/cli-local-tools are excluded from Changesets; use cli-release for CLI binaries and never target those packages in a changeset while they remain ignored.
Documentation-only and agent-guidance-only changes do not need a changeset.
Python release metadata lives in python/pyproject.toml, python/setup.py, and uv.lock.
Bumping generated clients is manual. Verify the package version is published before changing pins.

Local Guidance Files

TypeScript workspace: ts/AGENTS.md
Core SDK: ts/packages/core/AGENTS.md
TypeScript providers: ts/packages/providers/AGENTS.md
CLI: ts/packages/cli/AGENTS.md
E2E tests: ts/e2e-tests/AGENTS.md
Python SDK: python/AGENTS.md
Python providers: python/providers/AGENTS.md
Docs: docs/AGENTS.md

4.9 KiB Raw Permalink Blame History