vendure_add
Extend Vendure projects by adding API extensions, entities, services, job queues, or custom plugins. Specify plugin, entity, or service details to integrate new features seamlessly into your e-commerce setup.
Instructions
Add features to your Vendure project.
IMPORTANT USAGE PATTERNS:
- For API Extension: Requires apiExtension="plugin-name", plus queryName OR mutationName, plus selectedService
- For Entity: Requires entity="EntityName" and selectedPlugin="plugin-name"
- For Service: Requires service="ServiceName" and selectedPlugin="plugin-name"
- For Job Queue: Requires jobQueue="plugin-name", name="queue-name", and selectedService="service-name"
EXAMPLES:
- Add API extension: {apiExtension: "my-plugin", queryName: "customProducts", selectedService: "ProductService"}
- Add entity: {entity: "CustomProduct", selectedPlugin: "my-plugin"}
- Add service: {service: "CustomService", selectedPlugin: "my-plugin"}
- Create new plugin: {plugin: "MyNewPlugin"}
Use list_plugins tool first to see available plugin names.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| apiExtension | No | Add an API extension scaffold to the specified plugin. Provide the plugin name. Example: "my-plugin". Requires queryName or mutationName and selectedService. | |
| codegen | No | Add GraphQL codegen configuration to the specified plugin. Provide the plugin name. Example: "my-plugin" | |
| config | No | Specify the path to a custom Vendure config file. Example: "./custom-vendure-config.ts" | |
| customFields | No | Add custom fields support to the entity (boolean flag) | |
| entity | No | Add a new entity with the specified class name. Example: "Product" or "Customer". Requires selectedPlugin to be specified. | |
| jobQueue | No | Add job-queue support to the specified plugin. Provide the plugin name. Example: "my-plugin" | |
| mutationName | No | Name for the GraphQL mutation (used with apiExtension). Example: "createCustomOrder" or "updateSpecialPrice" | |
| name | No | Name for the job queue (required with jobQueue). Example: "email-queue" or "product-import-queue" | |
| plugin | No | Create a new plugin with the specified name. Example: "MyNewPlugin" | |
| projectPath | Yes | Path to the Vendure project directory (required) | |
| queryName | No | Name for the GraphQL query (used with apiExtension). Example: "customProducts" or "getSpecialOffers" | |
| selectedEntity | No | Name of the entity for entity service (automatically sets type to entity). Example: "Product" | |
| selectedPlugin | No | Name of the plugin to add the entity/service/api-extension to. Must be an existing plugin name. Example: "my-plugin" or "test-plugin" | |
| selectedService | No | Name of the service to add the job queue or API extension to. Must be an existing service. Example: "ProductService" | |
| service | No | Add a new service with the specified class name. Example: "ProductService" or "OrderService". Requires selectedPlugin to be specified. | |
| translatable | No | Make the entity translatable (boolean flag) | |
| type | No | Type of service: "basic" or "entity" (default: basic). Use "entity" when working with database entities. | |
| uiExtensions | No | Add Admin UI extensions setup to the specified plugin. Provide the plugin name. Example: "my-plugin" |