Home/Tools/@tpmjs/tools-compensation-band

compensationBandTool

@tpmjs/tools-compensation-band

Structures compensation data into salary bands with minimum, midpoint, and maximum values. Calculates percentiles, provides market comparison, and includes recommendations for competitive positioning.

Official
hr
v0.1.0
MIT
⚠️

This tool is currently broken

Execution Failed
Runtime error with test parameters
marketData must contain at least one data point

Last checked: 3/1/2026, 4:27:28 AM

Interactive Playground

Test @tpmjs/tools-compensation-band (compensationBandTool) 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-compensation-band
pnpm add @tpmjs/tools-compensation-band
yarn add @tpmjs/tools-compensation-band
bun add @tpmjs/tools-compensation-band
deno add npm:@tpmjs/tools-compensation-band

2. Import the tool

import { compensationBandTool } from '@tpmjs/tools-compensation-band';

3. Use with AI SDK

import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { compensationBandTool } from '@tpmjs/tools-compensation-band';

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

console.log(result.text);

Signature

(role: string, marketData: { equity: number; salary: number; source: string; location: string; totalComp: number }[], location?: string) => Promise<unknown>

Tags

ai
band
bands
benchmarking
compensation
data
hr
market
percentiles
positioning
recommendations
salary
structures
tpmjs

Parameters

Available configuration options

Auto-extracted
role
Required
Type: string

Role title (e.g., "Senior Software Engineer", "Product Manager")

marketData
Required
Type: array

Array of market compensation data points from various sources

location
Optional
Type: string

Geographic location for the role (e.g., "San Francisco, CA", "Remote - US")

Schema extracted: 3/1/2026, 4:27:27 AM

README

ERROR: No README data found!

Statistics

Downloads/month

0

Quality Score

0%

Bundle Size

NPM Keywords

tpmjs
hr
ai
compensation
salary
benchmarking

Maintainers

thomasdavis(thomasalwyndavis@gmail.com)

Frameworks

vercel-ai
compensationBandTool | TPMJS | TPMJS