add_project
Create new projects in Backlog by specifying name, key, and configuration options like chart display, subtasking, and text formatting rules.
Instructions
Creates a new project
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Project name | |
| key | Yes | Project key | |
| chartEnabled | No | Whether to enable chart (default: false) | |
| subtaskingEnabled | No | Whether to enable subtasking (default: false) | |
| projectLeaderCanEditProjectLeader | No | Whether project leaders can edit other project leaders (default: false) | |
| textFormattingRule | No | Text formatting rule (default: 'backlog') |
Implementation Reference
- src/tools/addProject.ts:60-76 (handler)The async handler function that executes the tool logic by calling backlog.postProject with the validated input parameters to create a new project.handler: async ({ name, key, chartEnabled, subtaskingEnabled, projectLeaderCanEditProjectLeader, textFormattingRule, }) => backlog.postProject({ name, key, chartEnabled: chartEnabled ?? false, subtaskingEnabled: subtaskingEnabled ?? false, projectLeaderCanEditProjectLeader: projectLeaderCanEditProjectLeader ?? false, textFormattingRule: textFormattingRule ?? 'backlog', }),
- src/tools/addProject.ts:7-46 (schema)Zod-based input schema for the 'add_project' tool, defining required name and key, and optional boolean flags and text formatting rule.const addProjectSchema = buildToolSchema((t) => ({ name: z.string().describe(t('TOOL_ADD_PROJECT_NAME', 'Project name')), key: z.string().describe(t('TOOL_ADD_PROJECT_KEY', 'Project key')), chartEnabled: z .boolean() .optional() .describe( t( 'TOOL_ADD_PROJECT_CHART_ENABLED', 'Whether to enable chart (default: false)' ) ), subtaskingEnabled: z .boolean() .optional() .describe( t( 'TOOL_ADD_PROJECT_SUBTASKING_ENABLED', 'Whether to enable subtasking (default: false)' ) ), projectLeaderCanEditProjectLeader: z .boolean() .optional() .describe( t( 'TOOL_ADD_PROJECT_LEADER_CAN_EDIT', 'Whether project leaders can edit other project leaders (default: false)' ) ), textFormattingRule: z .enum(['backlog', 'markdown']) .optional() .describe( t( 'TOOL_ADD_PROJECT_TEXT_FORMATTING', "Text formatting rule (default: 'backlog')" ) ), }));
- src/tools/tools.ts:81-86 (registration)Registration of the addProjectTool within the 'project' toolset group in the allTools function, alongside other project management tools.getProjectListTool(backlog, helper), addProjectTool(backlog, helper), getProjectTool(backlog, helper), updateProjectTool(backlog, helper), deleteProjectTool(backlog, helper), ],