LabscoConnect MCP ↗
get-convex logo✓ Official★ 63

convex-env

Keeps API keys and other secrets in your Convex deployment's settings instead of in the code, and reads them only in server-side actions.

by get-convexpart of get-convex/agent-skills

One of 30 skills in the get-convex/agent-skills package — works on its own, and pairs well with its siblings.

WHEN YOUR AGENT SHOULD USE IT

A QUICK BOUNDARY

USE FOR

  • Add an API key to a Convex deployment.
  • Give development and production their own values.
  • List what is set to confirm a change.

Documents

This is the playbook your agent receives when the skill activates — you don't need to read it to use the skill, but it's here to audit before installing.

Manage env vars + secrets

Store secrets as Convex deployment env vars (npx convex env set), read them with process.env in actions, never commit them.

Workflow
  1. npx convex env set KEY value (per deployment).
  2. Read via process.env.KEY inside actions (not queries/mutations).
  3. Never hardcode or commit secrets; add to .env.local only for local.
  4. Confirm with npx convex env list.
Rules
  • Secrets live in Convex env vars, never in code or git.
  • process.env only in actions ('use node' if needed), not queries/mutations.
  • Different deployments need their own values.

Installation

Copy & paste — that's it
npx skills add get-convex/agent-skills --skill "convex-env" --full-depth

Run this in your project — your agent picks the skill up automatically.

License

Licensed under Apache-2.0— you can use, modify, and redistribute it under that license's terms.

View the full license file on GitHub →