tpmjs/packages/tools/official/executive-brief/README.md
Ajax Davis 5d2096fb5d feat: add 100+ official TPMJS tools
Implements a comprehensive suite of AI SDK v6 tools across multiple categories:

- Research (5): page-brief, compare-pages, source-credibility, claim-checklist, timeline-from-text
- Web (10): fetch-text, links-catalog, extract-meta, extract-json-ld, redirect-trace, sitemap-read, rss-read, table-extract, robots-policy, url-normalize
- Data (15): csv-parse, csv-stringify, json-repair, json-schema-validate, yaml-parse, yaml-stringify, text-chunk, normalize-whitespace, dedupe-by-key, pivot, rows-filter, rows-sort, rows-group-aggregate, rows-join, schema-infer
- Doc (12): toc-generate, glossary-build, faq-from-text, executive-brief, decision-record-adr, prd-outline, acceptance-criteria, style-rewrite
- Eng (12): diff-text-unified, env-var-docs-generate, dependency-audit-lite, conventional-commit-suggest, markdown-lint-basic, test-case-generate, stacktrace-parse, release-notes, changelog-entry, release-checklist
- Security (7): redact-secrets, secret-scan-text, url-risk-heuristic, csp-compose, hardening-checklist-web, access-control-matrix, data-classification-heuristic
- Stats (9): effect-size-suite, bootstrap-ci, permutation-test, multiple-testing-adjust, linear-regression-ols, logistic-regression, time-series-decompose-lite, anomaly-detect-mad
- Ops (7): slo-draft, runbook-draft, postmortem-draft, postmortem-action-extractor, error-log-triage, coverage-tracker, monitoring-gap-analysis
- Agent (15): prompt-to-workflow-skeleton, workflow-validate-io, workflow-explain, workflow-cost-estimate, tool-call-accuracy-score, eval-fixture-build, guardrail-policy-draft, workflow-auto-repair, tool-selection-plan, novelty-score-workflow, workflow-variant-generate, config-normalize, recipe-*
- Utility (8): base64-encode, base64-decode, hash-text, regex-extract, template-render, date-parse, json-path-query, url-parse
- HTML (3): html-sanitize, html-to-markdown, markdown-to-html

All tools follow AI SDK v6 pattern with tool() and jsonSchema<T>().

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-31 22:55:56 +10:00

2.4 KiB

@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