Home/Tools/@tpmjs/tools-glossary-build

glossaryBuildTool

@tpmjs/tools-glossary-build

Build a glossary from term definitions in text. Detects patterns like "Term: definition", "Term - definition", "**Term** definition", and extracts them into a structured glossary. Returns an array of term-definition pairs with metadata about alphabetization.

Official
doc
v0.2.0
MIT

Interactive Playground

Test @tpmjs/tools-glossary-build (glossaryBuildTool) with AI-powered execution

0/2000 characters

Installation & Usage

Install this tool and use it with the AI SDK

1. Install the package

npm install @tpmjs/tools-glossary-build
pnpm add @tpmjs/tools-glossary-build
yarn add @tpmjs/tools-glossary-build
bun add @tpmjs/tools-glossary-build
deno add npm:@tpmjs/tools-glossary-build

2. Import the tool

import { glossaryBuildTool } from '@tpmjs/tools-glossary-build';

3. Use with AI SDK

import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { glossaryBuildTool } from '@tpmjs/tools-glossary-build';

const result = await generateText({
  model: openai('gpt-4o'),
  tools: { glossaryBuildTool },
  prompt: 'Your prompt here...',
});

console.log(result.text);

Parameters

Available configuration options

Auto-extracted
text
Required
Type: string

Text containing term definitions in various formats

Schema extracted: 1/1/2026, 8:18:21 AM

README

@tpmjs/tools-glossary-build

Build a glossary from term definitions in text. Detects various definition patterns and extracts them into a structured format.

Installation

npm install @tpmjs/tools-glossary-build ai

Usage

import { glossaryBuildTool } from '@tpmjs/tools-glossary-build';

const result = await glossaryBuildTool.execute({
  text: `
    API: Application Programming Interface
    REST - Representational State Transfer
    **JSON** JavaScript Object Notation
    CLI: Command Line Interface
  `,
});

console.log(result);
// {
//   terms: [
//     { term: "API", definition: "Application Programming Interface" },
//     { term: "REST", definition: "Representational State Transfer" },
//     { term: "JSON", definition: "JavaScript Object Notation" },
//     { term: "CLI", definition: "Command Line Interface" }
//   ],
//   count: 4,
//   alphabetized: true
// }

Features

  • Detects multiple definition formats:
    • Colon separator: Term: definition
    • Dash separator: Term - definition or Term — definition
    • Markdown bold: **Term** definition
    • Markdown italic: *Term* definition
  • Automatically removes duplicates (case-insensitive)
  • Cleans up formatting (bold markers, bullets, numbers)
  • Checks if terms are alphabetically sorted

Parameters

  • text (string, required) - Text containing term definitions in various formats

Returns

{
  terms: Array<{
    term: string;
    definition: string;
  }>;
  count: number;
  alphabetized: boolean;
}

Example Input Formats

The tool recognizes various definition formats:

API: Application Programming Interface
REST - Representational State Transfer
**GraphQL** A query language for APIs
*SDK* Software Development Kit

License

MIT

Statistics

Downloads/month

0

Quality Score

0%

Bundle Size

NPM Keywords

tpmjs
doc
ai
glossary
documentation

Maintainers

thomasdavis(thomasalwyndavis@gmail.com)

Frameworks

vercel-ai