@tpmjs/tools-vercel 0.1.0

package/README.md

@@ -0,0 +1,48 @@
+# @tpmjs/tools-vercel
+
+Vercel API tools for AI agents. Manage deployments, projects, domains, environment variables, and build logs.
+
+## Installation
+
+```bash
+npm install @tpmjs/tools-vercel
+```
+
+## Setup
+
+Set your Vercel API token:
+
+```bash
+export VERCEL_TOKEN="..."
+```
+
+## Usage
+
+```typescript
+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
+
+| Tool | Description |
+|------|-------------|
+| `listDeployments` | List deployments with optional state filtering |
+| `getDeployment` | Get details of a specific deployment |
+| `cancelDeployment` | Cancel a building deployment |
+| `listProjects` | List all projects in your account |
+| `getProject` | Get details of a specific project |
+| `listDomains` | List all domains in your account |
+| `getDomain` | Get details of a specific domain |
+| `listProjectDomains` | List domains assigned to a project |
+| `listEnvVars` | List environment variables for a project |
+| `createEnvVar` | Create a new environment variable |
+| `deleteEnvVar` | Delete an environment variable |
+| `getDeploymentEvents` | Get build logs and events for a deployment |
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,133 @@
+import * as ai from 'ai';
+
+/**
+ * @tpmjs/tools-vercel — Vercel API Tools for AI Agents
+ *
+ * Full access to the Vercel API: manage deployments, projects, domains,
+ * environment variables, and logs.
+ *
+ * @requires VERCEL_TOKEN environment variable
+ */
+interface ListDeploymentsInput {
+    projectId?: string;
+    teamId?: string;
+    state?: string;
+    limit?: number;
+}
+declare const listDeployments: ai.Tool<ListDeploymentsInput, {
+    deployments: unknown[];
+    pagination: unknown;
+}>;
+interface GetDeploymentInput {
+    idOrUrl: string;
+    teamId?: string;
+}
+declare const getDeployment: ai.Tool<GetDeploymentInput, Record<string, unknown>>;
+interface CancelDeploymentInput {
+    id: string;
+    teamId?: string;
+}
+declare const cancelDeployment: ai.Tool<CancelDeploymentInput, {
+    state: string;
+    uid: string;
+}>;
+interface ListProjectsInput {
+    teamId?: string;
+    limit?: number;
+    search?: string;
+}
+declare const listProjects: ai.Tool<ListProjectsInput, {
+    projects: unknown[];
+    pagination: unknown;
+}>;
+interface GetProjectInput {
+    idOrName: string;
+    teamId?: string;
+}
+declare const getProject: ai.Tool<GetProjectInput, Record<string, unknown>>;
+interface ListDomainsInput {
+    teamId?: string;
+    limit?: number;
+}
+declare const listDomains: ai.Tool<ListDomainsInput, {
+    domains: unknown[];
+    pagination: unknown;
+}>;
+interface GetDomainInput {
+    name: string;
+    teamId?: string;
+}
+declare const getDomain: ai.Tool<GetDomainInput, Record<string, unknown>>;
+interface ListProjectDomainsInput {
+    idOrName: string;
+    teamId?: string;
+    limit?: number;
+}
+declare const listProjectDomains: ai.Tool<ListProjectDomainsInput, {
+    domains: unknown[];
+    pagination: unknown;
+}>;
+interface ListEnvVarsInput {
+    idOrName: string;
+    teamId?: string;
+}
+declare const listEnvVars: ai.Tool<ListEnvVarsInput, {
+    envs: unknown[];
+}>;
+interface CreateEnvVarInput {
+    idOrName: string;
+    key: string;
+    value: string;
+    target: Array<'production' | 'preview' | 'development'>;
+    type?: 'plain' | 'secret' | 'encrypted' | 'sensitive';
+    teamId?: string;
+}
+declare const createEnvVar: ai.Tool<CreateEnvVarInput, {
+    created: Record<string, unknown>;
+}>;
+interface DeleteEnvVarInput {
+    idOrName: string;
+    envId: string;
+    teamId?: string;
+}
+declare const deleteEnvVar: ai.Tool<DeleteEnvVarInput, Record<string, unknown>>;
+interface GetDeploymentEventsInput {
+    idOrUrl: string;
+    teamId?: string;
+}
+declare const getDeploymentEvents: ai.Tool<GetDeploymentEventsInput, unknown[]>;
+declare const _default: {
+    listDeployments: ai.Tool<ListDeploymentsInput, {
+        deployments: unknown[];
+        pagination: unknown;
+    }>;
+    getDeployment: ai.Tool<GetDeploymentInput, Record<string, unknown>>;
+    cancelDeployment: ai.Tool<CancelDeploymentInput, {
+        state: string;
+        uid: string;
+    }>;
+    listProjects: ai.Tool<ListProjectsInput, {
+        projects: unknown[];
+        pagination: unknown;
+    }>;
+    getProject: ai.Tool<GetProjectInput, Record<string, unknown>>;
+    listDomains: ai.Tool<ListDomainsInput, {
+        domains: unknown[];
+        pagination: unknown;
+    }>;
+    getDomain: ai.Tool<GetDomainInput, Record<string, unknown>>;
+    listProjectDomains: ai.Tool<ListProjectDomainsInput, {
+        domains: unknown[];
+        pagination: unknown;
+    }>;
+    listEnvVars: ai.Tool<ListEnvVarsInput, {
+        envs: unknown[];
+    }>;
+    createEnvVar: ai.Tool<CreateEnvVarInput, {
+        created: Record<string, unknown>;
+    }>;
+    deleteEnvVar: ai.Tool<DeleteEnvVarInput, Record<string, unknown>>;
+    getDeploymentEvents: ai.Tool<GetDeploymentEventsInput, unknown[]>;
+};
+
+export { type CancelDeploymentInput, type CreateEnvVarInput, type DeleteEnvVarInput, type GetDeploymentEventsInput, type GetDeploymentInput, type GetDomainInput, type GetProjectInput, type ListDeploymentsInput, type ListDomainsInput, type ListEnvVarsInput, type ListProjectDomainsInput, type ListProjectsInput, cancelDeployment, createEnvVar, _default as default, deleteEnvVar, getDeployment, getDeploymentEvents, getDomain, getProject, listDeployments, listDomains, listEnvVars, listProjectDomains, listProjects };

package/dist/index.js

@@ -0,0 +1,414 @@
+import { tool, jsonSchema } from 'ai';
+
+// src/index.ts
+var BASE_URL = "https://api.vercel.com";
+function getApiKey() {
+  const token = process.env.VERCEL_TOKEN;
+  if (!token) {
+    throw new Error(
+      "VERCEL_TOKEN environment variable is required. Get your token from https://vercel.com/account/tokens"
+    );
+  }
+  return token;
+}
+async function apiRequest(method, path, body) {
+  const token = getApiKey();
+  const headers = {
+    Authorization: `Bearer ${token}`,
+    "Content-Type": "application/json"
+  };
+  const options = { method, headers };
+  if (body !== void 0) {
+    options.body = JSON.stringify(body);
+  }
+  const response = await fetch(`${BASE_URL}${path}`, options);
+  if (!response.ok) {
+    await handleApiError(response);
+  }
+  const text = await response.text();
+  if (!text) {
+    return {};
+  }
+  return JSON.parse(text);
+}
+async function handleApiError(response) {
+  let errorMessage;
+  try {
+    const errorData = await response.json();
+    errorMessage = errorData.error?.message || errorData.message || `HTTP ${response.status}`;
+  } catch {
+    errorMessage = `HTTP ${response.status}: ${response.statusText}`;
+  }
+  switch (response.status) {
+    case 400:
+      throw new Error(`Bad request: ${errorMessage}`);
+    case 401:
+      throw new Error("Authentication failed: Invalid Vercel token. Check VERCEL_TOKEN.");
+    case 403:
+      throw new Error(`Access forbidden: ${errorMessage}`);
+    case 404:
+      throw new Error(`Not found: ${errorMessage}`);
+    case 422:
+      throw new Error(`Validation error: ${errorMessage}`);
+    case 429:
+      throw new Error(`Rate limit exceeded: ${errorMessage}`);
+    default:
+      throw new Error(`Vercel API error (${response.status}): ${errorMessage}`);
+  }
+}
+function buildQueryString(params) {
+  const entries = Object.entries(params).filter(
+    ([, v]) => v !== void 0 && v !== null && v !== ""
+  );
+  if (entries.length === 0) return "";
+  return "?" + entries.map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join("&");
+}
+var listDeployments = tool({
+  description: "List deployments for a project or team. Filter by state (BUILDING, READY, ERROR, CANCELED). Returns recent deployments with URLs and status.",
+  inputSchema: jsonSchema({
+    type: "object",
+    properties: {
+      projectId: {
+        type: "string",
+        description: "Filter by project ID. Omit to list all deployments."
+      },
+      teamId: {
+        type: "string",
+        description: "Team ID for team-scoped requests."
+      },
+      state: {
+        type: "string",
+        description: "Filter by deployment state: BUILDING, READY, ERROR, or CANCELED."
+      },
+      limit: {
+        type: "number",
+        description: "Number of deployments to return (max 100, default 20)."
+      }
+    },
+    additionalProperties: false
+  }),
+  async execute(input) {
+    const params = {};
+    if (input.projectId) params.projectId = input.projectId;
+    if (input.state) params.state = input.state;
+    if (input.limit) params.limit = input.limit;
+    if (input.teamId) params.teamId = input.teamId;
+    const qs = buildQueryString(params);
+    return apiRequest("GET", `/v6/deployments${qs}`);
+  }
+});
+var getDeployment = tool({
+  description: "Get detailed information about a specific deployment by ID or URL. Returns build status, logs, environment details, and configuration.",
+  inputSchema: jsonSchema({
+    type: "object",
+    properties: {
+      idOrUrl: {
+        type: "string",
+        description: 'Deployment ID or URL (e.g., "dpl_xyz" or "myproject-abc.vercel.app").'
+      },
+      teamId: {
+        type: "string",
+        description: "Team ID for team-scoped requests."
+      }
+    },
+    required: ["idOrUrl"],
+    additionalProperties: false
+  }),
+  async execute(input) {
+    const qs = input.teamId ? buildQueryString({ teamId: input.teamId }) : "";
+    return apiRequest("GET", `/v13/deployments/${input.idOrUrl}${qs}`);
+  }
+});
+var cancelDeployment = tool({
+  description: "Cancel a running deployment by ID. Only works for deployments in BUILDING or QUEUED state.",
+  inputSchema: jsonSchema({
+    type: "object",
+    properties: {
+      id: {
+        type: "string",
+        description: 'Deployment ID to cancel (e.g., "dpl_xyz").'
+      },
+      teamId: {
+        type: "string",
+        description: "Team ID for team-scoped requests."
+      }
+    },
+    required: ["id"],
+    additionalProperties: false
+  }),
+  async execute(input) {
+    const qs = input.teamId ? buildQueryString({ teamId: input.teamId }) : "";
+    return apiRequest("PATCH", `/v12/deployments/${input.id}/cancel${qs}`);
+  }
+});
+var listProjects = tool({
+  description: "List all projects in your account or team. Supports search by name and pagination.",
+  inputSchema: jsonSchema({
+    type: "object",
+    properties: {
+      teamId: {
+        type: "string",
+        description: "Team ID to list projects for a specific team."
+      },
+      limit: {
+        type: "number",
+        description: "Number of projects to return (max 100, default 20)."
+      },
+      search: {
+        type: "string",
+        description: "Search projects by name."
+      }
+    },
+    additionalProperties: false
+  }),
+  async execute(input) {
+    const params = {};
+    if (input.teamId) params.teamId = input.teamId;
+    if (input.limit) params.limit = input.limit;
+    if (input.search) params.search = input.search;
+    const qs = buildQueryString(params);
+    return apiRequest("GET", `/v9/projects${qs}`);
+  }
+});
+var getProject = tool({
+  description: "Get detailed information about a specific project by ID or name. Returns configuration, environment variables, domains, and deployment settings.",
+  inputSchema: jsonSchema({
+    type: "object",
+    properties: {
+      idOrName: {
+        type: "string",
+        description: 'Project ID or name (e.g., "prj_xyz" or "my-project").'
+      },
+      teamId: {
+        type: "string",
+        description: "Team ID for team-scoped requests."
+      }
+    },
+    required: ["idOrName"],
+    additionalProperties: false
+  }),
+  async execute(input) {
+    const qs = input.teamId ? buildQueryString({ teamId: input.teamId }) : "";
+    return apiRequest("GET", `/v9/projects/${input.idOrName}${qs}`);
+  }
+});
+var listDomains = tool({
+  description: "List all domains in your account or team. Returns domain names, verification status, and configuration.",
+  inputSchema: jsonSchema({
+    type: "object",
+    properties: {
+      teamId: {
+        type: "string",
+        description: "Team ID to list domains for a specific team."
+      },
+      limit: {
+        type: "number",
+        description: "Number of domains to return (max 100, default 20)."
+      }
+    },
+    additionalProperties: false
+  }),
+  async execute(input) {
+    const params = {};
+    if (input.teamId) params.teamId = input.teamId;
+    if (input.limit) params.limit = input.limit;
+    const qs = buildQueryString(params);
+    return apiRequest("GET", `/v5/domains${qs}`);
+  }
+});
+var getDomain = tool({
+  description: "Get detailed information about a specific domain by name. Returns DNS records, verification status, and SSL configuration.",
+  inputSchema: jsonSchema({
+    type: "object",
+    properties: {
+      name: {
+        type: "string",
+        description: 'Domain name (e.g., "example.com").'
+      },
+      teamId: {
+        type: "string",
+        description: "Team ID for team-scoped requests."
+      }
+    },
+    required: ["name"],
+    additionalProperties: false
+  }),
+  async execute(input) {
+    const qs = input.teamId ? buildQueryString({ teamId: input.teamId }) : "";
+    return apiRequest("GET", `/v5/domains/${input.name}${qs}`);
+  }
+});
+var listProjectDomains = tool({
+  description: "List all domains assigned to a specific project. Returns domain names and their configuration.",
+  inputSchema: jsonSchema({
+    type: "object",
+    properties: {
+      idOrName: {
+        type: "string",
+        description: 'Project ID or name (e.g., "prj_xyz" or "my-project").'
+      },
+      teamId: {
+        type: "string",
+        description: "Team ID for team-scoped requests."
+      },
+      limit: {
+        type: "number",
+        description: "Number of domains to return (max 100, default 20)."
+      }
+    },
+    required: ["idOrName"],
+    additionalProperties: false
+  }),
+  async execute(input) {
+    const params = {};
+    if (input.teamId) params.teamId = input.teamId;
+    if (input.limit) params.limit = input.limit;
+    const qs = buildQueryString(params);
+    return apiRequest(
+      "GET",
+      `/v9/projects/${input.idOrName}/domains${qs}`
+    );
+  }
+});
+var listEnvVars = tool({
+  description: "List all environment variables for a project. Returns variable names, types, targets, and values (decrypted for system env vars).",
+  inputSchema: jsonSchema({
+    type: "object",
+    properties: {
+      idOrName: {
+        type: "string",
+        description: 'Project ID or name (e.g., "prj_xyz" or "my-project").'
+      },
+      teamId: {
+        type: "string",
+        description: "Team ID for team-scoped requests."
+      }
+    },
+    required: ["idOrName"],
+    additionalProperties: false
+  }),
+  async execute(input) {
+    const qs = input.teamId ? buildQueryString({ teamId: input.teamId }) : "";
+    return apiRequest("GET", `/v9/projects/${input.idOrName}/env${qs}`);
+  }
+});
+var createEnvVar = tool({
+  description: "Create a new environment variable for a project. Specify key, value, and target environments (production, preview, development).",
+  inputSchema: jsonSchema({
+    type: "object",
+    properties: {
+      idOrName: {
+        type: "string",
+        description: 'Project ID or name (e.g., "prj_xyz" or "my-project").'
+      },
+      key: {
+        type: "string",
+        description: 'Environment variable name (e.g., "DATABASE_URL").'
+      },
+      value: {
+        type: "string",
+        description: "Environment variable value."
+      },
+      target: {
+        type: "array",
+        items: {
+          type: "string",
+          enum: ["production", "preview", "development"]
+        },
+        description: "Target environments for this variable (production, preview, development)."
+      },
+      type: {
+        type: "string",
+        enum: ["plain", "secret", "encrypted", "sensitive"],
+        description: "Variable type: plain, secret, encrypted, or sensitive (default: encrypted)."
+      },
+      teamId: {
+        type: "string",
+        description: "Team ID for team-scoped requests."
+      }
+    },
+    required: ["idOrName", "key", "value", "target"],
+    additionalProperties: false
+  }),
+  async execute(input) {
+    const { idOrName, teamId, ...body } = input;
+    const qs = teamId ? buildQueryString({ teamId }) : "";
+    return apiRequest(
+      "POST",
+      `/v10/projects/${idOrName}/env${qs}`,
+      body
+    );
+  }
+});
+var deleteEnvVar = tool({
+  description: "Delete an environment variable from a project by its ID. Use listEnvVars to get the envId.",
+  inputSchema: jsonSchema({
+    type: "object",
+    properties: {
+      idOrName: {
+        type: "string",
+        description: 'Project ID or name (e.g., "prj_xyz" or "my-project").'
+      },
+      envId: {
+        type: "string",
+        description: "Environment variable ID (from listEnvVars)."
+      },
+      teamId: {
+        type: "string",
+        description: "Team ID for team-scoped requests."
+      }
+    },
+    required: ["idOrName", "envId"],
+    additionalProperties: false
+  }),
+  async execute(input) {
+    const qs = input.teamId ? buildQueryString({ teamId: input.teamId }) : "";
+    return apiRequest(
+      "DELETE",
+      `/v9/projects/${input.idOrName}/env/${input.envId}${qs}`
+    );
+  }
+});
+var getDeploymentEvents = tool({
+  description: "Get real-time build logs and events for a deployment. Returns a stream of build steps, output, and errors.",
+  inputSchema: jsonSchema({
+    type: "object",
+    properties: {
+      idOrUrl: {
+        type: "string",
+        description: 'Deployment ID or URL (e.g., "dpl_xyz" or "myproject-abc.vercel.app").'
+      },
+      teamId: {
+        type: "string",
+        description: "Team ID for team-scoped requests."
+      }
+    },
+    required: ["idOrUrl"],
+    additionalProperties: false
+  }),
+  async execute(input) {
+    const qs = input.teamId ? buildQueryString({ teamId: input.teamId }) : "";
+    return apiRequest("GET", `/v3/deployments/${input.idOrUrl}/events${qs}`);
+  }
+});
+var index_default = {
+  // Deployments
+  listDeployments,
+  getDeployment,
+  cancelDeployment,
+  // Projects
+  listProjects,
+  getProject,
+  // Domains
+  listDomains,
+  getDomain,
+  listProjectDomains,
+  // Environment Variables
+  listEnvVars,
+  createEnvVar,
+  deleteEnvVar,
+  // Logs
+  getDeploymentEvents
+};
+
+export { cancelDeployment, createEnvVar, index_default as default, deleteEnvVar, getDeployment, getDeploymentEvents, getDomain, getProject, listDeployments, listDomains, listEnvVars, listProjectDomains, listProjects };

package/package.json

@@ -0,0 +1,102 @@
+{
+  "name": "@tpmjs/tools-vercel",
+  "version": "0.1.0",
+  "description": "Vercel API tools for AI agents. Manage deployments, projects, domains, environment variables, and logs.",
+  "type": "module",
+  "keywords": [
+    "tpmjs",
+    "vercel",
+    "deployment",
+    "hosting",
+    "agent"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "type-check": "tsc --noEmit",
+    "clean": "rm -rf dist .turbo"
+  },
+  "devDependencies": {
+    "@tpmjs/tsconfig": "workspace:*",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "ai": "6.0.49"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tpmjs/tpmjs.git",
+    "directory": "packages/tools/official/vercel"
+  },
+  "homepage": "https://tpmjs.com",
+  "license": "MIT",
+  "tpmjs": {
+    "category": "ops",
+    "frameworks": [
+      "vercel-ai"
+    ],
+    "tools": [
+      {
+        "name": "listDeployments",
+        "description": "List deployments for a project or team with optional state filtering."
+      },
+      {
+        "name": "getDeployment",
+        "description": "Get details of a specific deployment by ID or URL."
+      },
+      {
+        "name": "cancelDeployment",
+        "description": "Cancel a deployment that is currently building."
+      },
+      {
+        "name": "listProjects",
+        "description": "List all projects in your Vercel account or team."
+      },
+      {
+        "name": "getProject",
+        "description": "Get details of a specific Vercel project by name or ID."
+      },
+      {
+        "name": "listDomains",
+        "description": "List all domains configured in your Vercel account."
+      },
+      {
+        "name": "getDomain",
+        "description": "Get details and configuration for a specific domain."
+      },
+      {
+        "name": "listProjectDomains",
+        "description": "List all domains assigned to a specific project."
+      },
+      {
+        "name": "listEnvVars",
+        "description": "List environment variables for a Vercel project."
+      },
+      {
+        "name": "createEnvVar",
+        "description": "Create a new environment variable on a Vercel project."
+      },
+      {
+        "name": "deleteEnvVar",
+        "description": "Delete an environment variable from a Vercel project."
+      },
+      {
+        "name": "getDeploymentEvents",
+        "description": "Get build logs and runtime events for a deployment."
+      }
+    ]
+  }
+}