get_project
Retrieve detailed information about a specific Backlog project using either its numeric ID or project key to access project data and settings.
Instructions
Returns information about a specific project
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | No | The numeric ID of the project (e.g., 12345) | |
| projectKey | No | The key of the project (e.g., 'PROJECT') |
Implementation Reference
- src/tools/getProject.ts:44-54 (handler)The handler function that resolves the project ID or key using resolveIdOrKey utility and retrieves the project details via the 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 for the get_project tool using Zod, defining optional projectId (number) and projectKey (string) with descriptions.
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/getProject.ts:29-56 (registration)The tool factory function that defines and exports the get_project tool, including name, description, input/output schemas, and handler.
export const getProjectTool = ( backlog: Backlog, { t }: TranslationHelper ): ToolDefinition< ReturnType<typeof getProjectSchema>, (typeof ProjectSchema)['shape'] > => { return { name: 'get_project', description: t( 'TOOL_GET_PROJECT_DESCRIPTION', 'Returns information about a specific project' ), schema: z.object(getProjectSchema(t)), outputSchema: ProjectSchema, 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/tools.ts:83-83 (registration)Instantiation and registration of the get_project tool factory within the central allTools function's 'project' toolset.
getProjectTool(backlog, helper),