Creating Modules

This guide walks you through creating a module from scratch.

Prerequisites

Node.js 18+
pnpm (recommended) or npm
An Odel developer account

Quick Start

1. Create a New Project

Visit the Dev Portal and click "New Project".

2. Set Up Your Environment

# Clone your project
git clone https://github.com/your-username/your-module.git
cd your-module

# Install dependencies
pnpm install

3. Define Your Module

import { createModule } from '@odel/module-sdk';

const module = createModule({
  name: 'my-module',
  version: '1.0.0',
})
  .tool({
    name: 'greet',
    description: 'Greet someone by name',
    parameters: {
      type: 'object',
      properties: {
        name: { type: 'string', description: 'Name to greet' },
      },
      required: ['name'],
    },
    execute: async ({ name }) => {
      return { greeting: `Hello, ${name}!` };
    },
  })
  .build();

export default module;

4. Test Locally

pnpm dev

5. Deploy

pnpm deploy

Next Steps

Learn more about the Module SDK
Publish your module to the marketplace

Creating Modules

On this page