Developer Packages
NetPad provides npm packages for developers who want to integrate NetPad forms, workflows, and applications into their projects. Each package serves a specific purpose and can be used independently or together.
Available Packagesโ
@netpad/formsโ
React component library for rendering NetPad forms in your applications.
Use when: You want to embed NetPad forms in your React application.
Key Features:
- 28+ field types
- Multi-page wizard support
- Conditional logic engine
- TypeScript support
- Form validation
- Custom styling
@netpad/workflowsโ
Type-safe TypeScript API client for NetPad workflows.
Use when: You need to trigger workflows programmatically from your backend or scripts.
Key Features:
- Workflow API client
- Execution management
- Type-safe TypeScript API
- Status polling utilities
- Error handling
@netpad/cliโ
Command-line tool for managing NetPad applications.
Use when: You want to manage NetPad applications, packages, and projects from the terminal.
Key Features:
- Install packages from npm registry
- Search for NetPad packages
- Create new application packages
- Authenticate with NetPad API
- Manage installed applications
@netpad/templatesโ
Production-ready form templates with encryption support.
Use when: You want to use pre-built form templates programmatically or create custom templates.
Key Features:
- 100+ production-ready templates
- 15 template categories
- Field-level encryption support
- Compliance frameworks (HIPAA, PCI-DSS, GDPR, SOC2, CCPA, FERPA)
- TypeScript support
- Tree-shakeable imports
@netpad/mcp-serverโ
MCP (Model Context Protocol) server for NetPad integration.
Use when: You want AI assistants (Claude Desktop, Cursor IDE) to help build NetPad applications.
Key Features:
- 75 AI-powered tools across 7 categories
- Form generation and workflow automation
- Application management and marketplace integration
- Conversational forms and RAG support
- Template library (25+ form templates)
Quick Comparisonโ
| Package | Type | Use Case | Documentation |
|---|---|---|---|
| @netpad/forms | React Library | Embed forms in React apps | Forms Package โ |
| @netpad/workflows | TypeScript Client | Trigger workflows programmatically | Workflows Package โ |
| @netpad/templates | Template Library | Pre-built templates with encryption | Templates Package โ |
| @netpad/cli | CLI Tool | Manage packages and applications | CLI Package โ |
| @netpad/mcp-server | MCP Server | AI-powered development assistance | MCP Server โ |
Installationโ
All Packagesโ
# Forms package
npm install @netpad/forms
# Workflows package
npm install @netpad/workflows
# Templates package
npm install @netpad/templates
# CLI (global)
npm install -g @netpad/cli
# MCP Server
npm install @netpad/mcp-server
Common Use Casesโ
Building a React Application with Formsโ
Use @netpad/forms to embed NetPad forms in your React application:
import { FormRenderer } from '@netpad/forms';
function MyApp() {
return <FormRenderer config={formConfig} onSubmit={handleSubmit} />;
}
Automating Workflows from Backendโ
Use @netpad/workflows to trigger workflows from your server:
import { createNetPadWorkflowClient } from '@netpad/workflows';
const client = createNetPadWorkflowClient({ /* config */ });
await client.executeWorkflow('workflow-id', { variables: {} });
Managing Applications via CLIโ
Use @netpad/cli to manage applications from the terminal:
netpad install @netpad/customer-portal
netpad publish
AI-Powered Developmentโ
Use @netpad/mcp-server with Claude Desktop or Cursor IDE:
"Create a customer feedback application with an NPS survey form"
Resourcesโ
- NPM Packages:
- @netpad/forms - React form renderer
- @netpad/workflows - Workflow API client
- @netpad/cli - Command-line tool
- @netpad/mcp-server - MCP server for AI tools
- GitHub: github.com/mongodb/netpad
- Examples:
/examples/directory in repository - API Documentation: API Reference
Next Stepsโ
- Forms Package - Embed forms in React applications
- Workflows Package - Trigger workflows programmatically
- Templates Package - Pre-built templates with encryption
- CLI Package - Manage applications from terminal
- MCP Server - AI-powered development tools
- API Reference - Complete API documentation
- Getting Started - Get started with NetPad