Module SDK
API reference for @odel/module-sdk
Module SDK
The @odel/module-sdk package provides a fluent API for building modules.
Installation
pnpm add @odel/module-sdkBasic Usage
import { createModule } from '@odel/module-sdk';
const module = createModule({
name: 'my-module',
version: '1.0.0',
})
.tool({ /* ... */ })
.resource({ /* ... */ })
.prompt({ /* ... */ })
.build();
export default module;API Reference
createModule(config)
Creates a new module builder.
createModule({
name: string; // Unique module identifier
version: string; // Semver version
}).tool(definition)
Adds a tool to the module.
.tool({
name: string; // Tool name
description: string; // Description for the AI
parameters: JSONSchema; // Input parameters schema
execute: Function; // Handler function
}).resource(definition)
Adds a resource to the module.
.resource({
name: string; // Resource name
description: string; // Description
mimeType: string; // Content type
fetch: Function; // Handler function
}).prompt(definition)
Adds a prompt template.
.prompt({
name: string; // Prompt name
description: string; // Description
template: string; // Prompt template
arguments: JSONSchema; // Template arguments
}).build()
Finalizes and returns the module configuration.