Skip to main content
Glama

add_plugin

Installs a feature plugin into an existing BackGen project, adding source files, routes, and dependencies. Use list_plugins to see available plugins, then run doctor to verify.

Instructions

Installs a feature plugin into an existing BackGen-generated project. Each plugin injects its own source files (controllers, routes, middleware, services), registers routes in app.ts, adds npm dependencies, injects environment variables into .env, and updates the .backgenrc.json manifest with ownership tracking. Call list_plugins first to see all available options with descriptions and categories. Run doctor afterwards to verify the project is healthy. IMPORTANT: jwt and clerk conflict — they cannot be installed together. The devops shorthand ('ci-github', 'dependabot', 'codeql', 'docker-registry', 'release') installs the full DevOps suite.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pluginYesPlugin to install. Categories: auth (jwt, clerk — mutually exclusive, pick one), payment (stripe), storage (s3), production (ratelimit), devops (ci-github, dependabot, codeql, docker-registry, release — install all with backgen add devops). Use list_plugins first to see descriptions.
dirNoAbsolute or relative path to the existing BackGen-generated project directory. Defaults to the current working directory. Example: '/home/user/projects/my-api'.
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Describes all actions: injects files, registers routes, adds dependencies, injects env vars, updates manifest. No annotations provided, so description fully covers behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single dense paragraph, but all sentences are necessary and informative. Slightly more structure (e.g., bullets) could improve scannability, but still concise.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Completely describes effects and prerequisites given no output schema. Covers plugin options, conflicts, dir default, and post-step (doctor).

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% (baseline 3). Description adds value beyond schema by explaining categories, mutual exclusivity, and devops shorthand for the plugin parameter.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool installs a feature plugin into a BackGen-generated project, with specific verb and resource. It distinguishes from siblings like list_plugins and remove_plugin.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicit guidance: call list_plugins first, run doctor afterwards. Warns about jwt/clerk conflict and explains devops shorthand. Provides clear when-to-use and alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/IbrahimKhaled19/BackGen'

If you have feedback or need assistance with the MCP directory API, please join our Discord server