delete_project
Remove a project from Backlog by specifying its ID or key, ensuring efficient project management and resource cleanup through API integration.
Instructions
Deletes a project
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectIdOrKey | Yes | Project ID or project key |
Implementation Reference
- src/tools/deleteProject.ts:29-53 (handler)Defines the 'delete_project' tool including its handler function. The handler resolves the project ID or key using resolveIdOrKey and executes backlog.deleteProject to delete the project.export const deleteProjectTool = ( backlog: Backlog, { t }: TranslationHelper ): ToolDefinition< ReturnType<typeof deleteProjectSchema>, (typeof ProjectSchema)['shape'] > => { return { name: 'delete_project', description: t('TOOL_DELETE_PROJECT_DESCRIPTION', 'Deletes a project'), schema: z.object(deleteProjectSchema(t)), outputSchema: ProjectSchema, handler: async ({ projectId, projectKey }) => { const result = resolveIdOrKey( 'project', { id: projectId, key: projectKey }, t ); if (!result.ok) { throw result.error; } return backlog.deleteProject(result.value); }, }; };
- src/tools/deleteProject.ts:8-27 (schema)Defines the Zod input schema for the delete_project tool, accepting optional projectId (number) or projectKey (string).const deleteProjectSchema = buildToolSchema((t) => ({ projectId: z .number() .optional() .describe( t( 'TOOL_DELETE_PROJECT_PROJECT_ID', 'The numeric ID of the project (e.g., 12345)' ) ), projectKey: z .string() .optional() .describe( t( 'TOOL_DELETE_PROJECT_PROJECT_KEY', "The key of the project (e.g., 'PROJECT')" ) ), }));
- src/tools/tools.ts:75-81 (registration)Registers deleteProjectTool by including it in the 'project' toolset within the allTools function.tools: [ getProjectListTool(backlog, helper), addProjectTool(backlog, helper), getProjectTool(backlog, helper), updateProjectTool(backlog, helper), deleteProjectTool(backlog, helper), ],
- src/tools/tools.ts:12-12 (registration)Imports the deleteProjectTool for use in tool registration.import { deleteProjectTool } from './deleteProject.js';