get_space
Retrieve detailed information about the Backlog space to manage projects, issues, and resources efficiently through API integration via the Backlog MCP Server.
Instructions
Returns information about the Backlog space
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/getSpace.ts:9-27 (handler)Defines the getSpaceTool, including the handler function that executes the core logic by calling backlog.getSpace() to retrieve space information.export const getSpaceTool = ( backlog: Backlog, { t }: TranslationHelper ): ToolDefinition< ReturnType<typeof getSpaceSchema>, (typeof SpaceSchema)['shape'] > => { return { name: 'get_space', description: t( 'TOOL_GET_SPACE_DESCRIPTION', 'Returns information about the Backlog space' ), schema: z.object(getSpaceSchema(t)), outputSchema: SpaceSchema, importantFields: ['spaceKey', 'name', 'lang', 'timezone'], handler: async () => backlog.getSpace(), }; };
- Zod schema defining the structure of the space object returned by the get_space tool.export const SpaceSchema = z.object({ spaceKey: z.string(), name: z.string(), ownerId: z.number(), lang: z.string(), timezone: z.string(), reportSendTime: z.string(), textFormattingRule: TextFormattingRuleSchema, created: z.string(), updated: z.string(), });
- src/tools/getSpace.ts:7-7 (schema)Defines the input schema for the get_space tool, which takes no parameters.const getSpaceSchema = buildToolSchema((_t) => ({}));
- src/tools/tools.ts:59-69 (registration)Registers the getSpaceTool as part of the 'space' toolset group in allTools.{ name: 'space', description: 'Tools for managing Backlog space settings and general information.', enabled: false, tools: [ getSpaceTool(backlog, helper), getUsersTool(backlog, helper), getMyselfTool(backlog, helper), ], },