get_users
Retrieve all user accounts from your Backlog project management workspace to manage team access and assign tasks.
Instructions
Returns list of users in the Backlog space
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/getUsers.ts:9-27 (handler)The getUsersTool function defines the MCP tool 'get_users', including its schema, description, and handler which executes backlog.getUsers() to fetch users from the Backlog space.
export const getUsersTool = ( backlog: Backlog, { t }: TranslationHelper ): ToolDefinition< ReturnType<typeof getUsersSchema>, (typeof UserSchema)['shape'] > => { return { name: 'get_users', description: t( 'TOOL_GET_USERS_DESCRIPTION', 'Returns list of users in the Backlog space' ), schema: z.object(getUsersSchema(t)), outputSchema: UserSchema, importantFields: ['userId', 'name', 'roleType', 'lang'], handler: async () => backlog.getUsers(), }; }; - src/tools/getUsers.ts:7-7 (schema)Defines the input schema for the get_users tool, which takes no parameters.
const getUsersSchema = buildToolSchema((_t) => ({})); - src/tools/tools.ts:70-73 (registration)Registers the getUsersTool as part of the 'space' toolset group in the allTools function.
getSpaceTool(backlog, helper), getUsersTool(backlog, helper), getMyselfTool(backlog, helper), ], - src/tools/getUsers.ts:22-24 (schema)Specifies the input schema (empty object), output schema as UserSchema, and important fields for the get_users tool.
schema: z.object(getUsersSchema(t)), outputSchema: UserSchema, importantFields: ['userId', 'name', 'roleType', 'lang'],