get_project
Retrieve detailed information about a specific project using its ID or key, enabling efficient management and access to Backlog project resources via API integration.
Instructions
Returns information about a specific project
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectIdOrKey | Yes | Project ID or project key |
Implementation Reference
- src/tools/getProject.ts:44-54 (handler)The executing handler logic for the get_project tool. Resolves project ID or key and fetches project details from Backlog API.handler: async ({ projectId, projectKey }) => { const result = resolveIdOrKey( 'project', { id: projectId, key: projectKey }, t ); if (!result.ok) { throw result.error; } return backlog.getProject(result.value); },
- src/tools/getProject.ts:8-27 (schema)Input schema definition using Zod for projectId (optional number) and projectKey (optional string).const getProjectSchema = buildToolSchema((t) => ({ projectId: z .number() .optional() .describe( t( 'TOOL_GET_PROJECT_PROJECT_ID', 'The numeric ID of the project (e.g., 12345)' ) ), projectKey: z .string() .optional() .describe( t( 'TOOL_GET_PROJECT_PROJECT_KEY', "The key of the project (e.g., 'PROJECT')" ) ), }));
- src/tools/tools.ts:70-82 (registration)Registration of getProjectTool within the 'project' toolset group in allTools function, which collects and instantiates all tools.{ name: 'project', description: 'Tools for managing projects, categories, custom fields, and issue types.', enabled: false, tools: [ getProjectListTool(backlog, helper), addProjectTool(backlog, helper), getProjectTool(backlog, helper), updateProjectTool(backlog, helper), deleteProjectTool(backlog, helper), ], },
- src/index.ts:96-99 (registration)Final registration of the entire toolset group (including get_project) to the MCP server via registerTools.const toolsetGroup = buildToolsetGroup(backlog, transHelper, enabledToolsets); // Register all tools registerTools(server, toolsetGroup, mcpOption);