Home/Tools/@tpmjs/tools-executive-brief

executiveBriefTool

@tpmjs/tools-executive-brief

Format content into an executive summary style with a concise overview and key bullet points. Ideal for distilling long documents into decision-maker friendly summaries.

Official
documentation
v0.2.0
MIT

Interactive Playground

Test @tpmjs/tools-executive-brief (executiveBriefTool) 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-executive-brief
pnpm add @tpmjs/tools-executive-brief
yarn add @tpmjs/tools-executive-brief
bun add @tpmjs/tools-executive-brief
deno add npm:@tpmjs/tools-executive-brief

2. Import the tool

import { executiveBriefTool } from '@tpmjs/tools-executive-brief';

3. Use with AI SDK

import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { executiveBriefTool } from '@tpmjs/tools-executive-brief';

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

console.log(result.text);

Parameters

Available configuration options

Auto-extracted
content
Required
Type: string

The content to format into an executive brief

maxBullets
Optional
Type: number

Maximum number of bullet points to include (default: 5)

Schema extracted: 1/1/2026, 8:17:52 AM

README

@tpmjs/tools-executive-brief

Format content into executive summary style with key bullets and concise overview.

Installation

npm install @tpmjs/tools-executive-brief

Usage

import { executiveBriefTool } from '@tpmjs/tools-executive-brief';

const result = await executiveBriefTool.execute({
  content: `Our Q4 performance exceeded expectations with revenue growing 25% year-over-year.
    The product launch was successful, acquiring 10,000 new customers in the first month.
    Customer satisfaction scores improved to 4.5/5. We expanded to three new markets.
    The team grew from 50 to 75 employees. Infrastructure costs were reduced by 15%.`,
  maxBullets: 5,
});

console.log(result.brief);
// # Executive Brief
//
// ## Overview
// Our Q4 performance exceeded expectations with revenue growing 25% year-over-year.
// The product launch was successful, acquiring 10,000 new customers in the first month.
// Customer satisfaction scores improved to 4.5/5.
//
// ## Key Points
// - Our Q4 performance exceeded expectations with revenue growing 25% year-over-year
// - The product launch was successful, acquiring 10,000 new customers in the first month
// - Customer satisfaction scores improved to 4.5/5
// - We expanded to three new markets
// - Infrastructure costs were reduced by 15%

console.log(result.bulletCount); // 5
console.log(result.wordCount);   // ~75

API

executiveBriefTool.execute(input)

Formats content into an executive brief with overview and key bullet points.

Input

  • content (string, required): The content to format into an executive brief
  • maxBullets (number, optional): Maximum number of bullet points (default: 5)

Output

Returns a Promise<ExecutiveBrief> with:

  • brief (string): The formatted brief in markdown
  • bulletCount (number): Number of bullet points included
  • wordCount (number): Total word count of the brief

Features

  • Smart bullet extraction: Identifies key points with action words, numbers, and important indicators
  • Concise overview: Summarizes the main message in 2-3 sentences
  • Markdown formatting: Returns clean, readable markdown
  • Configurable: Adjust the number of bullets to fit your needs

Use Cases

  • Summarize long reports for executives
  • Create meeting briefs from detailed notes
  • Distill technical documents for non-technical audiences
  • Generate quick summaries of proposals or plans

License

MIT

Statistics

Downloads/month

37

Quality Score

78%

Bundle Size

NPM Keywords

tpmjs
documentation
ai
executive-summary
business

Maintainers

thomasdavis(thomasalwyndavis@gmail.com)

Frameworks

vercel-ai
executiveBriefTool | TPMJS | TPMJS