Home/Tools/@tpmjs/tools-vercel

getDomain

@tpmjs/tools-vercel

Get details and configuration for a specific domain.

Official
ops
v0.2.0
MIT

Interactive Playground

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

2. Import the tool

import { getDomain } from '@tpmjs/tools-vercel';

3. Use with AI SDK

import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { getDomain } from '@tpmjs/tools-vercel';

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

console.log(result.text);

Signature

(name: string, teamId?: string) => Promise<unknown>

Tags

agent
configuration
deployment
details
domain
hosting
ops
specific
tpmjs
vercel

Parameters

Available configuration options

Auto-extracted
name
Required
Type: string

Domain name (e.g., "example.com").

teamId
Optional
Type: string

Team ID for team-scoped requests.

Schema extracted: 3/1/2026, 4:28:55 AM

README

@tpmjs/tools-vercel

Vercel API tools for AI agents. Manage deployments, projects, domains, environment variables, and build logs.

Installation

npm install @tpmjs/tools-vercel

Setup

Set your Vercel API token:

export VERCEL_TOKEN="..."

Usage

import { listDeployments, getProject, listEnvVars } from '@tpmjs/tools-vercel';

const deployments = await listDeployments.execute({ projectId: 'my-project', limit: 5 });
const project = await getProject.execute({ idOrName: 'my-project' });
const envVars = await listEnvVars.execute({ idOrName: 'my-project' });

Tools

ToolDescription
listDeploymentsList deployments with optional state filtering
getDeploymentGet details of a specific deployment
cancelDeploymentCancel a building deployment
listProjectsList all projects in your account
getProjectGet details of a specific project
listDomainsList all domains in your account
getDomainGet details of a specific domain
listProjectDomainsList domains assigned to a project
listEnvVarsList environment variables for a project
createEnvVarCreate a new environment variable
deleteEnvVarDelete an environment variable
getDeploymentEventsGet build logs and events for a deployment

License

MIT

Statistics

Downloads/month

198

GitHub Stars

9

Quality Score

89%

Bundle Size

NPM Keywords

tpmjs
vercel
deployment
hosting
agent

Maintainers

thomasdavis(thomasalwyndavis@gmail.com)

Frameworks

vercel-ai
getDomain | TPMJS | TPMJS