History

Ajax Davis 2cd2b10cd0 refactor: replace exportName with name throughout codebase - Update TpmjsToolDefinitionSchema to only use 'name' field - Add 'sandbox' as valid category for sprites tools - Update all package.json files to use 'name' instead of 'exportName' - Update documentation and source files accordingly - Add 11 new sprites tools for sandbox/code-execution		2026-01-14 14:18:36 +10:00
..
src	feat: implement playground app with AI SDK v6 tool execution	2025-12-04 02:51:02 +10:00
CHANGELOG.md	feat: implement multi-tool package architecture with manual tool registry	2025-12-04 06:39:58 +10:00
package.json	refactor: replace exportName with name throughout codebase	2026-01-14 14:18:36 +10:00
README.md	feat: add npm-like features to tool detail page and update keyword to tpmjs	2025-12-29 21:30:42 +10:00
tsconfig.json	feat: implement playground app with AI SDK v6 tool execution	2025-12-04 02:51:02 +10:00

README.md

@tpmjs/hello

Simple example TPMJS tools for AI SDK v6 - demonstrates how to create tools that work with AI agents.

Tools

helloWorldTool

Returns a simple "Hello, World!" greeting with a timestamp.

Parameters: None

Returns:

{
  "message": "Hello, World!",
  "timestamp": "2024-12-04T..."
}

helloNameTool

Returns a personalized greeting with the provided name.

Parameters:

name (string, required): The name of the person to greet

Returns:

{
  "message": "Hello, John!",
  "timestamp": "2024-12-04T..."
}

Usage

With AI SDK v6

import { streamText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { helloWorldTool, helloNameTool } from '@tpmjs/hello';

const result = streamText({
  model: openai('gpt-4o-mini'),
  messages: [{ role: 'user', content: 'Say hello to Alice' }],
  tools: {
    helloWorld: helloWorldTool,
    helloName: helloNameTool,
  },
});

Template for Creating TPMJS Tools

This package serves as a template for creating your own TPMJS tools. Key requirements:

Use AI SDK v6 Beta (ai@6.0.0-beta.124)
Use Zod 4 for parameter validation
Export tool objects with description, parameters, and execute

Add TPMJS metadata to package.json:

"tpmjs": {
  "category": "text-analysis",
  "description": "Your tool description"
}

Include the tpmjs keyword in package.json

Development

# Build
pnpm build

# Type check
pnpm type-check

# Watch mode
pnpm dev