add_project
Create a new project in Backlog with customizable settings such as project name, key, chart and subtask functionality, text formatting rules, and leader editing permissions.
Instructions
Creates a new project
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| chartEnabled | No | Whether to enable chart (default: false) | |
| key | Yes | Project key | |
| name | Yes | Project name | |
| projectLeaderCanEditProjectLeader | No | Whether project leaders can edit other project leaders (default: false) | |
| subtaskingEnabled | No | Whether to enable subtasking (default: false) | |
| textFormattingRule | No | Text formatting rule (default: 'backlog') |
Implementation Reference
- src/tools/addProject.ts:60-77 (handler)The async handler function for the 'add_project' tool. It takes input parameters and calls backlog.postProject() to create a new project, applying default values for optional boolean and enum fields.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 schema definition for the input parameters of the 'add_project' tool using buildToolSchema.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:75-81 (registration)The 'add_project' tool is registered (via addProjectTool factory) in the 'project' toolset group within the allTools function.tools: [ getProjectListTool(backlog, helper), addProjectTool(backlog, helper), getProjectTool(backlog, helper), updateProjectTool(backlog, helper), deleteProjectTool(backlog, helper), ],
- src/tools/addProject.ts:48-79 (schema)Full tool definition including name 'add_project', input schema (from addProjectSchema), output schema (ProjectSchema), description, and handler. This factory function is called during registration.export const addProjectTool = ( backlog: Backlog, { t }: TranslationHelper ): ToolDefinition< ReturnType<typeof addProjectSchema>, (typeof ProjectSchema)['shape'] > => { return { name: 'add_project', description: t('TOOL_ADD_PROJECT_DESCRIPTION', 'Creates a new project'), schema: z.object(addProjectSchema(t)), outputSchema: ProjectSchema, handler: async ({ name, key, chartEnabled, subtaskingEnabled, projectLeaderCanEditProjectLeader, textFormattingRule, }) => backlog.postProject({ name, key, chartEnabled: chartEnabled ?? false, subtaskingEnabled: subtaskingEnabled ?? false, projectLeaderCanEditProjectLeader: projectLeaderCanEditProjectLeader ?? false, textFormattingRule: textFormattingRule ?? 'backlog', }), }; };