backlog-mcp-server 0.4.0

package/build/tools/tools.js

@@ -0,0 +1,143 @@
+import { addIssueTool } from './addIssue.js';
+import { addIssueCommentTool } from './addIssueComment.js';
+import { addProjectTool } from './addProject.js';
+import { addPullRequestTool } from './addPullRequest.js';
+import { addPullRequestCommentTool } from './addPullRequestComment.js';
+import { addWikiTool } from './addWiki.js';
+import { countIssuesTool } from './countIssues.js';
+import { deleteIssueTool } from './deleteIssue.js';
+import { deleteProjectTool } from './deleteProject.js';
+import { getCategoriesTool } from './getCategories.js';
+import { getCustomFieldsTool } from './getCustomFields.js';
+import { getGitRepositoriesTool } from './getGitRepositories.js';
+import { getGitRepositoryTool } from './getGitRepository.js';
+import { getIssueTool } from './getIssue.js';
+import { getIssueCommentsTool } from './getIssueComments.js';
+import { getIssuesTool } from './getIssues.js';
+import { getIssueTypesTool } from './getIssueTypes.js';
+import { getMyselfTool } from './getMyself.js';
+import { getNotificationsTool } from './getNotifications.js';
+import { getNotificationsCountTool } from './getNotificationsCount.js';
+import { getPrioritiesTool } from './getPriorities.js';
+import { getProjectTool } from './getProject.js';
+import { getProjectListTool } from './getProjectList.js';
+import { getPullRequestTool } from './getPullRequest.js';
+import { getPullRequestCommentsTool } from './getPullRequestComments.js';
+import { getPullRequestsTool } from './getPullRequests.js';
+import { getPullRequestsCountTool } from './getPullRequestsCount.js';
+import { getResolutionsTool } from './getResolutions.js';
+import { getSpaceTool } from './getSpace.js';
+import { getUsersTool } from './getUsers.js';
+import { getWatchingListCountTool } from './getWatchingListCount.js';
+import { getWatchingListItemsTool } from './getWatchingListItems.js';
+import { getWikiTool } from './getWiki.js';
+import { getWikiPagesTool } from './getWikiPages.js';
+import { getWikisCountTool } from './getWikisCount.js';
+import { markNotificationAsReadTool } from './markNotificationAsRead.js';
+import { resetUnreadNotificationCountTool } from './resetUnreadNotificationCount.js';
+import { updateIssueTool } from './updateIssue.js';
+import { updateProjectTool } from './updateProject.js';
+import { updatePullRequestTool } from './updatePullRequest.js';
+import { updatePullRequestCommentTool } from './updatePullRequestComment.js';
+import { getDocumentTool } from './getDocument.js';
+import { getDocumentsTool } from './getDocuments.js';
+import { getDocumentTreeTool } from './getDocumentTree.js';
+export const allTools = (backlog, helper) => {
+    return {
+        toolsets: [
+            {
+                name: 'space',
+                description: 'Tools for managing Backlog space settings and general information.',
+                enabled: false,
+                tools: [
+                    getSpaceTool(backlog, helper),
+                    getUsersTool(backlog, helper),
+                    getMyselfTool(backlog, helper),
+                ],
+            },
+            {
+                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),
+                ],
+            },
+            {
+                name: 'issue',
+                description: 'Tools for managing issues and their comments.',
+                enabled: false,
+                tools: [
+                    getIssueTool(backlog, helper),
+                    getIssuesTool(backlog, helper),
+                    countIssuesTool(backlog, helper),
+                    addIssueTool(backlog, helper),
+                    updateIssueTool(backlog, helper),
+                    deleteIssueTool(backlog, helper),
+                    getIssueCommentsTool(backlog, helper),
+                    addIssueCommentTool(backlog, helper),
+                    getPrioritiesTool(backlog, helper),
+                    getCategoriesTool(backlog, helper),
+                    getCustomFieldsTool(backlog, helper),
+                    getIssueTypesTool(backlog, helper),
+                    getResolutionsTool(backlog, helper),
+                    getWatchingListItemsTool(backlog, helper),
+                    getWatchingListCountTool(backlog, helper),
+                ],
+            },
+            {
+                name: 'wiki',
+                description: 'Tools for managing wiki pages.',
+                enabled: false,
+                tools: [
+                    getWikiPagesTool(backlog, helper),
+                    getWikisCountTool(backlog, helper),
+                    getWikiTool(backlog, helper),
+                    addWikiTool(backlog, helper),
+                ],
+            },
+            {
+                name: 'git',
+                description: 'Tools for managing Git repositories and pull requests.',
+                enabled: false,
+                tools: [
+                    getGitRepositoriesTool(backlog, helper),
+                    getGitRepositoryTool(backlog, helper),
+                    getPullRequestsTool(backlog, helper),
+                    getPullRequestsCountTool(backlog, helper),
+                    getPullRequestTool(backlog, helper),
+                    addPullRequestTool(backlog, helper),
+                    updatePullRequestTool(backlog, helper),
+                    getPullRequestCommentsTool(backlog, helper),
+                    addPullRequestCommentTool(backlog, helper),
+                    updatePullRequestCommentTool(backlog, helper),
+                ],
+            },
+            {
+                name: 'document',
+                description: 'Tools for managing documents.',
+                enabled: false,
+                tools: [
+                    getDocumentsTool(backlog, helper),
+                    getDocumentTreeTool(backlog, helper),
+                    getDocumentTool(backlog, helper),
+                ],
+            },
+            {
+                name: 'notifications',
+                description: 'Tools for managing user notifications.',
+                enabled: false,
+                tools: [
+                    getNotificationsTool(backlog, helper),
+                    getNotificationsCountTool(backlog, helper),
+                    resetUnreadNotificationCountTool(backlog, helper),
+                    markNotificationAsReadTool(backlog, helper),
+                ],
+            },
+        ],
+    };
+};

package/build/tools/updateIssue.js

@@ -0,0 +1,116 @@
+import { z } from 'zod';
+import { buildToolSchema } from '../types/tool.js';
+import { IssueSchema } from '../types/zod/backlogOutputDefinition.js';
+import { resolveIdOrKey } from '../utils/resolveIdOrKey.js';
+import { customFieldsToPayload } from '../backlog/customFields.js';
+const updateIssueSchema = buildToolSchema((t) => ({
+    issueId: z
+        .number()
+        .optional()
+        .describe(t('TOOL_UPDATE_ISSUE_ISSUE_ID', 'The numeric ID of the issue (e.g., 12345)')),
+    issueKey: z
+        .string()
+        .optional()
+        .describe(t('TOOL_UPDATE_ISSUE_ISSUE_KEY', "The key of the issue (e.g., 'PROJ-123')")),
+    summary: z
+        .string()
+        .optional()
+        .describe(t('TOOL_UPDATE_ISSUE_SUMMARY', 'Summary of the issue')),
+    issueTypeId: z
+        .number()
+        .optional()
+        .describe(t('TOOL_UPDATE_ISSUE_ISSUE_TYPE_ID', 'Issue type ID')),
+    priorityId: z
+        .number()
+        .optional()
+        .describe(t('TOOL_UPDATE_ISSUE_PRIORITY_ID', 'Priority ID')),
+    description: z
+        .string()
+        .optional()
+        .describe(t('TOOL_UPDATE_ISSUE_DESCRIPTION', 'Detailed description of the issue')),
+    startDate: z
+        .string()
+        .optional()
+        .describe(t('TOOL_UPDATE_ISSUE_START_DATE', 'Scheduled start date (yyyy-MM-dd)')),
+    dueDate: z
+        .string()
+        .optional()
+        .describe(t('TOOL_UPDATE_ISSUE_DUE_DATE', 'Scheduled due date (yyyy-MM-dd)')),
+    estimatedHours: z
+        .number()
+        .optional()
+        .describe(t('TOOL_UPDATE_ISSUE_ESTIMATED_HOURS', 'Estimated work hours')),
+    actualHours: z
+        .number()
+        .optional()
+        .describe(t('TOOL_UPDATE_ISSUE_ACTUAL_HOURS', 'Actual work hours')),
+    categoryId: z
+        .array(z.number())
+        .optional()
+        .describe(t('TOOL_UPDATE_ISSUE_CATEGORY_ID', 'Category IDs')),
+    versionId: z
+        .array(z.number())
+        .optional()
+        .describe(t('TOOL_UPDATE_ISSUE_VERSION_ID', 'Version IDs')),
+    milestoneId: z
+        .array(z.number())
+        .optional()
+        .describe(t('TOOL_UPDATE_ISSUE_MILESTONE_ID', 'Milestone IDs')),
+    statusId: z
+        .number()
+        .optional()
+        .describe(t('TOOL_UPDATE_ISSUE_STATUS_ID', 'Status ID')),
+    resolutionId: z
+        .number()
+        .optional()
+        .describe(t('TOOL_UPDATE_ISSUE_RESOLUTION_ID', 'Resolution ID')),
+    assigneeId: z
+        .number()
+        .optional()
+        .describe(t('TOOL_UPDATE_ISSUE_ASSIGNEE_ID', 'User ID of the assignee')),
+    notifiedUserId: z
+        .array(z.number())
+        .optional()
+        .describe(t('TOOL_UPDATE_ISSUE_NOTIFIED_USER_ID', 'User IDs to notify')),
+    attachmentId: z
+        .array(z.number())
+        .optional()
+        .describe(t('TOOL_UPDATE_ISSUE_ATTACHMENT_ID', 'Attachment IDs')),
+    comment: z
+        .string()
+        .optional()
+        .describe(t('TOOL_UPDATE_ISSUE_COMMENT', 'Comment to add when updating the issue')),
+    customFields: z
+        .array(z.object({
+        id: z
+            .number()
+            .describe(t('TOOL_UPDATE_ISSUE_CUSTOM_FIELD_ID', 'The ID of the custom field (e.g., 12345)')),
+        value: z.union([z.string().max(255), z.number(), z.array(z.string())]),
+        otherValue: z
+            .string()
+            .optional()
+            .describe(t('TOOL_UPDATE_ISSUE_CUSTOM_FIELD_OTHER_VALUE', 'Other value for list type fields')),
+    }))
+        .optional()
+        .describe(t('TOOL_UPDATE_ISSUE_CUSTOM_FIELDS', 'List of custom fields to set on the issue')),
+}));
+export const updateIssueTool = (backlog, { t }) => {
+    return {
+        name: 'update_issue',
+        description: t('TOOL_UPDATE_ISSUE_DESCRIPTION', 'Updates an existing issue'),
+        schema: z.object(updateIssueSchema(t)),
+        outputSchema: IssueSchema,
+        handler: async ({ issueId, issueKey, customFields, ...params }) => {
+            const result = resolveIdOrKey('issue', { id: issueId, key: issueKey }, t);
+            if (!result.ok) {
+                throw result.error;
+            }
+            const customFieldPayload = customFieldsToPayload(customFields);
+            const finalPayload = {
+                ...params,
+                ...customFieldPayload,
+            };
+            return backlog.patchIssue(result.value, finalPayload);
+        },
+    };
+};

package/build/tools/updateProject.js

@@ -0,0 +1,57 @@
+import { z } from 'zod';
+import { buildToolSchema } from '../types/tool.js';
+import { ProjectSchema } from '../types/zod/backlogOutputDefinition.js';
+import { resolveIdOrKey } from '../utils/resolveIdOrKey.js';
+const updateProjectSchema = buildToolSchema((t) => ({
+    projectId: z
+        .number()
+        .optional()
+        .describe(t('TOOL_UPDATE_PROJECT_PROJECT_ID', 'The numeric ID of the project (e.g., 12345)')),
+    projectKey: z
+        .string()
+        .optional()
+        .describe(t('TOOL_UPDATE_PROJECT_PROJECT_KEY', "The key of the project (e.g., 'PROJECT')")),
+    name: z
+        .string()
+        .optional()
+        .describe(t('TOOL_UPDATE_PROJECT_NAME', 'Project name')),
+    key: z
+        .string()
+        .optional()
+        .describe(t('TOOL_UPDATE_PROJECT_KEY', 'Project key')),
+    chartEnabled: z
+        .boolean()
+        .optional()
+        .describe(t('TOOL_UPDATE_PROJECT_CHART_ENABLED', 'Whether to enable chart')),
+    subtaskingEnabled: z
+        .boolean()
+        .optional()
+        .describe(t('TOOL_UPDATE_PROJECT_SUBTASKING_ENABLED', 'Whether to enable subtasking')),
+    projectLeaderCanEditProjectLeader: z
+        .boolean()
+        .optional()
+        .describe(t('TOOL_UPDATE_PROJECT_LEADER_CAN_EDIT', 'Whether project leaders can edit other project leaders')),
+    textFormattingRule: z
+        .enum(['backlog', 'markdown'])
+        .optional()
+        .describe(t('TOOL_UPDATE_PROJECT_TEXT_FORMATTING', 'Text formatting rule')),
+    archived: z
+        .boolean()
+        .optional()
+        .describe(t('TOOL_UPDATE_PROJECT_ARCHIVED', 'Whether to archive the project')),
+}));
+export const updateProjectTool = (backlog, { t }) => {
+    return {
+        name: 'update_project',
+        description: t('TOOL_UPDATE_PROJECT_DESCRIPTION', 'Updates an existing project'),
+        schema: z.object(updateProjectSchema(t)),
+        outputSchema: ProjectSchema,
+        handler: async ({ projectId, projectKey, ...param }) => {
+            const result = resolveIdOrKey('project', { id: projectId, key: projectKey }, t);
+            if (!result.ok) {
+                throw result.error;
+            }
+            return backlog.patchProject(result.value, param);
+        },
+    };
+};

package/build/tools/updatePullRequest.js

@@ -0,0 +1,68 @@
+import { z } from 'zod';
+import { buildToolSchema } from '../types/tool.js';
+import { PullRequestSchema } from '../types/zod/backlogOutputDefinition.js';
+import { resolveIdOrKey } from '../utils/resolveIdOrKey.js';
+const updatePullRequestSchema = buildToolSchema((t) => ({
+    projectId: z
+        .number()
+        .optional()
+        .describe(t('TOOL_UPDATE_PULL_REQUEST_PROJECT_ID', 'The numeric ID of the project (e.g., 12345)')),
+    projectKey: z
+        .string()
+        .optional()
+        .describe(t('TOOL_UPDATE_PULL_REQUEST_PROJECT_KEY', "The key of the project (e.g., 'PROJECT')")),
+    repoId: z
+        .number()
+        .optional()
+        .describe(t('TOOL_UPDATE_PULL_REQUEST_REPO_ID', 'Repository ID')),
+    repoName: z
+        .string()
+        .optional()
+        .describe(t('TOOL_UPDATE_PULL_REQUEST_REPO_NAME', 'Repository name')),
+    number: z
+        .number()
+        .describe(t('TOOL_UPDATE_PULL_REQUEST_NUMBER', 'Pull request number')),
+    summary: z
+        .string()
+        .optional()
+        .describe(t('TOOL_UPDATE_PULL_REQUEST_SUMMARY', 'Summary of the pull request')),
+    description: z
+        .string()
+        .optional()
+        .describe(t('TOOL_UPDATE_PULL_REQUEST_DESCRIPTION', 'Description of the pull request')),
+    issueId: z
+        .number()
+        .optional()
+        .describe(t('TOOL_UPDATE_PULL_REQUEST_ISSUE_ID', 'Issue ID to link')),
+    assigneeId: z
+        .number()
+        .optional()
+        .describe(t('TOOL_UPDATE_PULL_REQUEST_ASSIGNEE_ID', 'User ID of the assignee')),
+    notifiedUserId: z
+        .array(z.number())
+        .optional()
+        .describe(t('TOOL_UPDATE_PULL_REQUEST_NOTIFIED_USER_ID', 'User IDs to notify')),
+    statusId: z
+        .number()
+        .optional()
+        .describe(t('TOOL_UPDATE_PULL_REQUEST_STATUS_ID', 'Status ID')),
+}));
+export const updatePullRequestTool = (backlog, { t }) => {
+    return {
+        name: 'update_pull_request',
+        description: t('TOOL_UPDATE_PULL_REQUEST_DESCRIPTION', 'Updates an existing pull request'),
+        schema: z.object(updatePullRequestSchema(t)),
+        outputSchema: PullRequestSchema,
+        handler: async ({ projectId, projectKey, repoId, repoName, number, ...params }) => {
+            const result = resolveIdOrKey('project', { id: projectId, key: projectKey }, t);
+            if (!result.ok) {
+                throw result.error;
+            }
+            const resultRepo = resolveIdOrKey('repository', { id: repoId, key: repoName }, t);
+            if (!resultRepo.ok) {
+                throw resultRepo.error;
+            }
+            return backlog.patchPullRequest(result.value, String(resultRepo.value), number, params);
+        },
+    };
+};

package/build/tools/updatePullRequestComment.js

@@ -0,0 +1,51 @@
+import { z } from 'zod';
+import { buildToolSchema } from '../types/tool.js';
+import { PullRequestCommentSchema } from '../types/zod/backlogOutputDefinition.js';
+import { resolveIdOrKey, resolveIdOrName } from '../utils/resolveIdOrKey.js';
+const updatePullRequestCommentSchema = buildToolSchema((t) => ({
+    projectId: z
+        .number()
+        .optional()
+        .describe(t('TOOL_UPDATE_PULL_REQUEST_COMMENT_PROJECT_ID', 'The numeric ID of the project (e.g., 12345)')),
+    projectKey: z
+        .string()
+        .optional()
+        .describe(t('TOOL_UPDATE_PULL_REQUEST_COMMENT_PROJECT_KEY', "The key of the project (e.g., 'PROJECT')")),
+    repoId: z
+        .number()
+        .optional()
+        .describe(t('TOOL_UPDATE_PULL_REQUEST_COMMENT_REPO_ID', 'Repository ID')),
+    repoName: z
+        .string()
+        .optional()
+        .describe(t('TOOL_UPDATE_PULL_REQUEST_COMMENT_REPO_NAME', 'Repository name')),
+    number: z
+        .number()
+        .describe(t('TOOL_UPDATE_PULL_REQUEST_COMMENT_NUMBER', 'Pull request number')),
+    commentId: z
+        .number()
+        .describe(t('TOOL_UPDATE_PULL_REQUEST_COMMENT_COMMENT_ID', 'Comment ID')),
+    content: z
+        .string()
+        .describe(t('TOOL_UPDATE_PULL_REQUEST_COMMENT_CONTENT', 'Comment content')),
+}));
+export const updatePullRequestCommentTool = (backlog, { t }) => {
+    return {
+        name: 'update_pull_request_comment',
+        description: t('TOOL_UPDATE_PULL_REQUEST_COMMENT_DESCRIPTION', 'Updates a comment on a pull request'),
+        schema: z.object(updatePullRequestCommentSchema(t)),
+        outputSchema: PullRequestCommentSchema,
+        importantFields: ['id', 'content', 'createdUser', 'updated'],
+        handler: async ({ projectId, projectKey, repoId, repoName, number, commentId, content, }) => {
+            const result = resolveIdOrKey('project', { id: projectId, key: projectKey }, t);
+            if (!result.ok) {
+                throw result.error;
+            }
+            const repoResult = resolveIdOrName('repository', { id: repoId, name: repoName }, t);
+            if (!repoResult.ok) {
+                throw repoResult.error;
+            }
+            return backlog.patchPullRequestComments(result.value, String(repoResult.value), number, commentId, { content });
+        },
+    };
+};

package/build/types/mcp.js

@@ -0,0 +1 @@
+export {};

package/build/types/result.js

@@ -0,0 +1,3 @@
+export function isErrorLike(res) {
+    return res.kind === 'error';
+}

package/build/types/tool.js

@@ -0,0 +1 @@
+export const buildToolSchema = (fn) => fn;

package/build/types/toolsets.js

@@ -0,0 +1 @@
+export {};