Skip to main content
Glama
nulab

Backlog MCP Server

get_issue_types

Retrieve a list of issue types for a specific project by providing its numeric ID or key.

Instructions

Returns list of issue types for a project

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectIdNoThe numeric ID of the project (e.g., 12345)
projectKeyNoThe key of the project (e.g., 'PROJECT')
organizationNoOptional organization name. Use list_organizations to inspect available organizations.

Implementation Reference

  • Main handler for get_issue_types tool. Resolves project ID or key, then calls backlog.getIssueTypes() to return the list of issue types for a project.
    export const getIssueTypesTool = (
      backlog: Backlog,
      { t }: TranslationHelper
    ): ToolDefinition<
      ReturnType<typeof getIssueTypesSchema>,
      (typeof IssueTypeSchema)['shape']
    > => {
      return {
        name: 'get_issue_types',
        description: t(
          'TOOL_GET_ISSUE_TYPES_DESCRIPTION',
          'Returns list of issue types for a project'
        ),
        schema: z.object(getIssueTypesSchema(t)),
        outputSchema: IssueTypeSchema,
        importantFields: ['id', 'name'],
        handler: async ({ projectId, projectKey }) => {
          const result = resolveIdOrKey(
            'project',
            { id: projectId, key: projectKey },
            t
          );
          if (!result.ok) {
            throw result.error;
          }
          return backlog.getIssueTypes(result.value);
        },
      };
  • Input schema: optional projectId (number) and projectKey (string). At least one required.
    const getIssueTypesSchema = buildToolSchema((t) => ({
      projectId: z
        .number()
        .optional()
        .describe(
          t(
            'TOOL_GET_GIT_REPOSITORIES_PROJECT_ID',
            'The numeric ID of the project (e.g., 12345)'
          )
        ),
      projectKey: z
        .string()
        .optional()
        .describe(
          t(
            'TOOL_GET_GIT_REPOSITORIES_PROJECT_KEY',
            "The key of the project (e.g., 'PROJECT')"
          )
        ),
    }));
  • Output schema for issue types - defines fields: id, projectId, name, color (enum), displayOrder, optional templateSummary and templateDescription.
    export const IssueTypeSchema = z.object({
      id: z.number(),
      projectId: z.number(),
      name: z.string(),
      color: IssueTypeColorSchema,
      displayOrder: z.number(),
      templateSummary: z.string().optional(),
      templateDescription: z.string().optional(),
    });
  • Registration of getIssueTypesTool in the 'issue' toolset group.
        getIssueTypesTool(backlog, helper),
        getResolutionsTool(backlog, helper),
        getWatchingListItemsTool(backlog, helper),
        getWatchingListCountTool(backlog, helper),
        addWatchingTool(backlog, helper),
        updateWatchingTool(backlog, helper),
        deleteWatchingTool(backlog, helper),
        markWatchingAsReadTool(backlog, helper),
        getVersionMilestoneListTool(backlog, helper),
        addVersionMilestoneTool(backlog, helper),
        updateVersionMilestoneTool(backlog, helper),
        deleteVersionTool(backlog, helper),
      ],
    },
  • Import statement for getIssueTypesTool in the tools registration module.
    import { getIssueTypesTool } from './getIssueTypes.js';
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are present, so the description must carry the full burden of behavioral disclosure. It only says 'Returns list' with no mention of read-only nature, authentication, rate limits, or side effects. The tool is clearly a read operation, but this is not explicitly stated.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence that conveys the essential purpose without extra words. It is appropriately front-loaded and efficient.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given 3 optional parameters and no output schema, the description is somewhat complete but fails to clarify that at least one of 'projectId' or 'projectKey' is likely required, or the role of 'organization'. It covers the core purpose but lacks nuance.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the parameters are well-documented in the schema. However, the description adds no additional meaning beyond the schema, such as explaining that 'projectId' and 'projectKey' are alternative identifiers or when to use 'organization'.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states 'Returns list of issue types for a project', specifying the verb (returns), resource (list of issue types), and scope (for a project). This distinguishes it from sibling tools like 'get_issues' or 'get_categories'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool vs alternatives, nor when not to use it. The description does not mention why one might choose this over similar tools like 'get_issues' or how the parameters relate.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/nulab/backlog-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server