About commet
commet is a skill for implementing and maintaining Commet integrations. It directs agents to use the installed SDK’s documentation and types as the contract, with checks for compatibility and safeguards around remote changes.
Key features
- 01Resolve installed SDK and version
- 02Use artifact-specific documentation and types
- 03Run Commet CLI diagnostics when available
- 04Guide integration implementation and testing
- 05Require context checks for remote effects
Use cases
- 01Building a new Commet integration
- 02Updating an existing integration safely
- 03Investigating SDK or API compatibility
- 04Preparing authorized changes to Commet resources
Install
Copy the command and run it in a terminal.
npx skills add https:/ / github.com/ commet-labs/ skills --skill commetAfter installing, type/commetin Claude Code to confirm it loaded.
Details
From the project READMECommet integration
Treat the installed SDK as the contract. This skill sequences the work; it does not carry a copy of the API surface.
Resolve installed context
Before changing an integration:
- Inspect dependency manifests and lockfiles for every Commet SDK, integration package, CLI, direct REST call, and explicit API or webhook version.
- Identify the package actually imported by the target application. If multiple versions are installed, do not assume the newest one is active.
- Resolve
docs/manifest.jsonfrom that installed artifact, read the manifest entrypoint, and then read only the relevant generated reference and Platform documents named by the manifest. - Read generated types from the same installed artifact when the task depends on an exact request, response, error, or webhook shape.
- If the installed artifact has no documentation, stop and report the exact package and version. Do not silently substitute current web documentation for an older installed contract.
Use the package manager rather than a source checkout to locate the artifact:
| Ecosystem | Installed documentation |
|---|---|
| Node | node_modules/@commet/node/docs/ plus the installed integration package README |
| Python | Resolve the installed commet module, then use its docs/ directory |
| Go | Read the Commet module path from go.mod, resolve it with go list -m -f '{{.Dir}}', then use docs/ |
| Java | Resolve the co.commet:commet-java dependency and read commet/docs/ from its JAR resources |
| PHP | vendor/commet/commet-php/docs/ |
For a new integration with no SDK installed, install the requested language package first when the user asked for implementation. Then read the documentation from that installed package before writing integration code.
Use Node diagnostics
When the commet CLI executable is present, run from the project root:
commet doctor --output agent
Parse the JSON even when the command exits non-zero. Use its status, apiVersion, check code, evidence, impact, and action; never inspect or print secret values. Resolve failed package, documentation, compatibility, API-version, or project-context checks before relying on the integration.
If a Node package is installed but the CLI is not, report that doctor evidence is unavailable and continue with the installed package documentation. Do not install or execute a package implicitly. When the user asks to add the CLI, resolve its compatible installation from the installed documentation first.
Do not run commet agents setup merely because doctor reports stale rules. It writes to the repository and requires an explicit user request.
Implement
- Trace the existing integration and preserve its language, framework, customer identity, API-version, and idempotency boundaries.
- Use only operations and fields present in the installed manifest, generated reference, and types.
- Prefer direct subscription and feature-access queries for authorization decisions. Use webhooks for asynchronous work, not as a replicated source of billing truth.
- Preserve caller-owned logical event identifiers and explicit idempotency keys where the installed documentation requires them.
- Handle the installed error contract and preserve the server request ID exactly for support correlation.
- Run the repository's formatter, typecheck or compile, tests, and a focused integration check proportional to the change.
Guard effects
Repository inspection, code edits, builds, and local tests do not require remote organization context. Any action that creates, updates, deletes, pushes, migrates, forwards, or tests Commet resources does.
Before a remote effect:
- Name the exact organization and whether it is
sandboxorlive. - In Node projects where doctor is available, require a passing
PROJECT_CONTEXT_VALIDcheck and use its evidence. - Otherwise, require the organization and mode from explicit project configuration or the user; never infer mode from an API-key prefix.
- State the target before executing. Do not perform a live write unless the user's request explicitly authorizes that effect.
- Prefer a documented dry run or sandbox verification when available. Do not invent flags or remote behavior that the installed documentation does not expose.
Never expose API keys, webhook secrets, authorization tokens, or full environment values in output, patches, logs, or tests.