@pschroee/redmine-mcp 0.3.3 → 0.4.0

package/README.md

@@ -44,7 +44,18 @@ npx @pschroee/redmine-mcp@latest --url=https://your-redmine.com --api-key=your-a
 | `roles` | 2 | Roles listing and details |
 | `admin` | 11 | Users & Groups management (admin only) |
 
-**Total: 70 Tools**
+**Total: 70 Core Tools**
+
+### Plugin Groups (enabled by default, require RedmineUP plugins)
+
+| Group | Tools | Description |
+|-------|-------|-------------|
+| `plugin_checklists` | 5 | Checklist items (requires [redmine_checklists](https://www.redmineup.com/pages/plugins/checklists) plugin) |
+| `plugin_agile` | 7 | Agile sprints & story points (requires [redmine_agile](https://www.redmineup.com/pages/plugins/agile) plugin) |
+
+**Total: 12 Plugin Tools**
+
+> **Note:** Plugin tools are enabled by default but require the corresponding RedmineUP plugins to be installed on your Redmine server. If a plugin is not installed, the tools will return errors when used. Use `--exclude=plugin_checklists,plugin_agile` to disable them.
 
 ## Usage Examples
 
@@ -66,6 +77,12 @@ npx @pschroee/redmine-mcp@latest --tools=core,metadata
 npx @pschroee/redmine-mcp@latest --exclude=wiki,files
 ```
 
+### Exclude plugin tools (if plugins not installed)
+
+```bash
+npx @pschroee/redmine-mcp@latest --exclude=plugin_checklists,plugin_agile
+```
+
 ## Claude Configuration
 
 ### Quick Setup with Claude CLI
@@ -102,6 +119,24 @@ claude mcp add redmine -s user -- cmd /c npx -y @pschroee/redmine-mcp \
   --tools=core,metadata,search
 ```
 
+### Without Plugin Tools
+
+**macOS / Linux:**
+
+```bash
+claude mcp add redmine -s user -- npx -y @pschroee/redmine-mcp@latest \
+  --url=https://your-redmine.com --api-key=your-api-key \
+  --exclude=plugin_checklists,plugin_agile
+```
+
+**Windows:**
+
+```bash
+claude mcp add redmine -s user -- cmd /c npx -y @pschroee/redmine-mcp@latest \
+  --url=https://your-redmine.com --api-key=your-api-key \
+  --exclude=plugin_checklists,plugin_agile
+```
+
 ### Manual Configuration (Claude Desktop)
 
 #### macOS / Linux
@@ -292,6 +327,28 @@ Add to your Claude Desktop config (`%APPDATA%\Claude\claude_desktop_config.json`
 - `add_user_to_group` - Add user to group
 - `remove_user_from_group` - Remove user from group
 
+### Plugin: Checklists (plugin_checklists)
+
+> Requires [redmine_checklists](https://www.redmineup.com/pages/plugins/checklists) plugin
+
+- `list_checklists` - List checklist items for an issue
+- `get_checklist` - Get checklist item details
+- `create_checklist` - Create checklist item
+- `update_checklist` - Update checklist item (text, done status)
+- `delete_checklist` - Delete checklist item
+
+### Plugin: Agile (plugin_agile)
+
+> Requires [redmine_agile](https://www.redmineup.com/pages/plugins/agile) plugin
+
+- `list_agile_sprints` - List sprints for a project
+- `get_agile_sprint` - Get sprint details
+- `create_agile_sprint` - Create sprint
+- `update_agile_sprint` - Update sprint
+- `delete_agile_sprint` - Delete sprint
+- `get_issue_agile_data` - Get agile data for issue (position, story points, sprint)
+- `update_issue_agile_data` - Update agile data for issue
+
 ## Development
 
 ```bash
@@ -329,12 +386,12 @@ npm test
 
 ### Test Coverage
 
-The test suite includes 195 tests across 12 test files:
+The test suite includes 198 tests across 12 test files:
 
 | Test File | Tests | Description |
 |-----------|-------|-------------|
 | `account.test.ts` | 1 | Current user account |
-| `core.test.ts` | 48 | Projects and Issues CRUD |
+| `core.test.ts` | 51 | Projects and Issues CRUD |
 | `metadata.test.ts` | 14 | Trackers, Statuses, Categories |
 | `relations.test.ts` | 24 | Versions and Issue Relations |
 | `wiki.test.ts` | 14 | Wiki Pages CRUD |

package/dist/index.js

@@ -2,7 +2,7 @@
 import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
 import { RedmineClient } from "./redmine/client.js";
 import { createServer } from "./server.js";
-import { resolveGroups, ALL_GROUPS } from "./tools/index.js";
+import { resolveGroups, ALL_GROUPS, PLUGIN_GROUPS } from "./tools/index.js";
 function printHelp() {
     console.log(`
 Redmine MCP Server
@@ -16,13 +16,15 @@ Options:
   --exclude=<groups>    Comma-separated list of tool groups to exclude
   --help                Show this help message
 
-Tool Groups:
+Tool Groups (all enabled by default):
   ${ALL_GROUPS.join(", ")}
 
+Note: Plugin groups (${PLUGIN_GROUPS.join(", ")}) require RedmineUP plugins installed.
+
 Examples:
   redmine-mcp --url=https://redmine.example.com --api-key=abc123
   redmine-mcp --tools=core,metadata
-  redmine-mcp --exclude=wiki,files
+  redmine-mcp --exclude=wiki,files,plugin_checklists,plugin_agile
 `);
 }
 function parseArgs() {

package/dist/redmine/client.d.ts

@@ -1,4 +1,4 @@
-import type { RedmineIssue, RedmineIssuesResponse, RedmineProject, RedmineProjectsResponse, RedmineResult, RedmineWikiPage, RedmineWikiPagesResponse, RedmineAttachment, RedmineUploadResponse, RedmineFilesResponse, RedmineRelation, RedmineRelationsResponse, RedmineVersion, RedmineVersionsResponse, RedmineTrackersResponse, RedmineIssueStatusesResponse, RedmineCategory, RedmineCategoriesResponse, RedmineCustomFieldsResponse, RedmineQueriesResponse, RedmineSearchResponse, RedmineMyAccountResponse, RedmineTimeEntry, RedmineTimeEntriesResponse, RedmineIssuePrioritiesResponse, RedmineTimeEntryActivitiesResponse, RedmineDocumentCategoriesResponse, RedmineUser, RedmineUsersResponse, RedmineGroup, RedmineGroupsResponse, RedmineMembership, RedmineMembershipsResponse, RedmineRole, RedmineRolesResponse } from "./types.js";
+import type { RedmineIssue, RedmineIssuesResponse, RedmineProject, RedmineProjectsResponse, RedmineResult, RedmineWikiPage, RedmineWikiPagesResponse, RedmineAttachment, RedmineUploadResponse, RedmineFilesResponse, RedmineRelation, RedmineRelationsResponse, RedmineVersion, RedmineVersionsResponse, RedmineTrackersResponse, RedmineIssueStatusesResponse, RedmineCategory, RedmineCategoriesResponse, RedmineCustomFieldsResponse, RedmineQueriesResponse, RedmineSearchResponse, RedmineMyAccountResponse, RedmineTimeEntry, RedmineTimeEntriesResponse, RedmineIssuePrioritiesResponse, RedmineTimeEntryActivitiesResponse, RedmineDocumentCategoriesResponse, RedmineUser, RedmineUsersResponse, RedmineGroup, RedmineGroupsResponse, RedmineMembership, RedmineMembershipsResponse, RedmineRole, RedmineRolesResponse, RedmineChecklist, RedmineChecklistsResponse, RedmineAgileSprint, RedmineAgileSprintsResponse, RedmineAgileData } from "./types.js";
 export declare class RedmineClient {
     private baseUrl;
     private apiKey;
@@ -347,4 +347,53 @@ export declare class RedmineClient {
     getRole(id: number): Promise<RedmineResult<{
         role: RedmineRole;
     }>>;
+    listChecklists(issueId: number): Promise<RedmineResult<RedmineChecklistsResponse>>;
+    getChecklist(id: number): Promise<RedmineResult<{
+        checklist: RedmineChecklist;
+    }>>;
+    createChecklist(data: {
+        issue_id: number;
+        subject: string;
+        is_done?: boolean;
+        position?: number;
+    }): Promise<RedmineResult<{
+        checklist: RedmineChecklist;
+    }>>;
+    updateChecklist(id: number, data: {
+        subject?: string;
+        is_done?: boolean;
+        position?: number;
+    }): Promise<RedmineResult<void>>;
+    deleteChecklist(id: number): Promise<RedmineResult<void>>;
+    listAgileSprints(projectId: string | number): Promise<RedmineResult<RedmineAgileSprintsResponse>>;
+    getAgileSprint(projectId: string | number, sprintId: number): Promise<RedmineResult<{
+        agile_sprint: RedmineAgileSprint;
+    }>>;
+    createAgileSprint(projectId: string | number, data: {
+        name: string;
+        status?: string;
+        start_date?: string;
+        end_date?: string;
+        description?: string;
+        sharing?: string;
+    }): Promise<RedmineResult<{
+        agile_sprint: RedmineAgileSprint;
+    }>>;
+    updateAgileSprint(projectId: string | number, sprintId: number, data: {
+        name?: string;
+        status?: string;
+        start_date?: string;
+        end_date?: string;
+        description?: string;
+        sharing?: string;
+    }): Promise<RedmineResult<void>>;
+    deleteAgileSprint(projectId: string | number, sprintId: number): Promise<RedmineResult<void>>;
+    getIssueAgileData(issueId: number): Promise<RedmineResult<{
+        agile_data: RedmineAgileData;
+    }>>;
+    updateIssueAgileData(issueId: number, data: {
+        position?: number;
+        story_points?: number;
+        agile_sprint_id?: number | null;
+    }): Promise<RedmineResult<void>>;
 }

package/dist/redmine/client.js

@@ -477,4 +477,50 @@ export class RedmineClient {
     async getRole(id) {
         return this.request("GET", `/roles/${id}.json`);
     }
+    // ==================== CHECKLISTS (Plugin) ====================
+    async listChecklists(issueId) {
+        return this.request("GET", `/issues/${issueId}/checklists.json`);
+    }
+    async getChecklist(id) {
+        return this.request("GET", `/checklists/${id}.json`);
+    }
+    async createChecklist(data) {
+        return this.request("POST", "/checklists.json", {
+            checklist: data,
+        });
+    }
+    async updateChecklist(id, data) {
+        return this.request("PUT", `/checklists/${id}.json`, {
+            checklist: data,
+        });
+    }
+    async deleteChecklist(id) {
+        return this.request("DELETE", `/checklists/${id}.json`);
+    }
+    // ==================== AGILE (Plugin) ====================
+    async listAgileSprints(projectId) {
+        return this.request("GET", `/projects/${projectId}/agile_sprints.json`);
+    }
+    async getAgileSprint(projectId, sprintId) {
+        return this.request("GET", `/projects/${projectId}/agile_sprints/${sprintId}.json`);
+    }
+    async createAgileSprint(projectId, data) {
+        return this.request("POST", `/projects/${projectId}/agile_sprints.json`, { agile_sprint: data });
+    }
+    async updateAgileSprint(projectId, sprintId, data) {
+        return this.request("PUT", `/projects/${projectId}/agile_sprints/${sprintId}.json`, { agile_sprint: data });
+    }
+    async deleteAgileSprint(projectId, sprintId) {
+        return this.request("DELETE", `/projects/${projectId}/agile_sprints/${sprintId}.json`);
+    }
+    async getIssueAgileData(issueId) {
+        return this.request("GET", `/issues/${issueId}/agile_data.json`);
+    }
+    async updateIssueAgileData(issueId, data) {
+        return this.request("PUT", `/issues/${issueId}.json`, {
+            issue: {
+                agile_data_attributes: data,
+            },
+        });
+    }
 }

package/dist/redmine/types.d.ts

@@ -487,3 +487,40 @@ export interface RedmineRole {
 export interface RedmineRolesResponse {
     roles: RedmineRole[];
 }
+export interface RedmineChecklist {
+    id: number;
+    issue_id: number;
+    subject: string;
+    is_done: boolean;
+    position: number;
+    created_at: string;
+    updated_at: string;
+}
+export interface RedmineChecklistsResponse {
+    checklists: RedmineChecklist[];
+}
+export interface RedmineAgileSprint {
+    id: number;
+    name: string;
+    status: string;
+    start_date?: string;
+    end_date?: string;
+    description?: string;
+    sharing?: string;
+    is_active?: boolean;
+    created_at?: string;
+    updated_at?: string;
+}
+export interface RedmineAgileSprintsResponse {
+    agile_sprints: RedmineAgileSprint[];
+}
+export interface RedmineAgileData {
+    id: number;
+    issue_id: number;
+    position: number;
+    story_points?: number;
+    agile_sprint_id?: number;
+}
+export interface RedmineAgileDataResponse {
+    agile_data: RedmineAgileData;
+}

package/dist/server.js

@@ -3,7 +3,7 @@ import { registerTools } from "./tools/index.js";
 export function createServer(redmineClient, toolGroups) {
     const server = new McpServer({
         name: "redmine-mcp",
-        version: "0.3.3",
+        version: "0.4.0",
     });
     registerTools(server, redmineClient, toolGroups);
     return server;

package/dist/tools/agile.d.ts

@@ -0,0 +1,3 @@
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import type { RedmineClient } from "../redmine/client.js";
+export declare function registerAgileTools(server: McpServer, client: RedmineClient): void;

package/dist/tools/agile.js

@@ -0,0 +1,103 @@
+import { z } from "zod";
+export function registerAgileTools(server, client) {
+    // === SPRINTS ===
+    server.registerTool("list_agile_sprints", {
+        description: "List all agile sprints for a project (requires redmine_agile plugin)",
+        inputSchema: {
+            project_id: z.union([z.string(), z.number()]).describe("Project ID or identifier"),
+        },
+    }, async (params) => {
+        const result = await client.listAgileSprints(params.project_id);
+        return {
+            content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
+        };
+    });
+    server.registerTool("get_agile_sprint", {
+        description: "Get details of a specific agile sprint (requires redmine_agile plugin)",
+        inputSchema: {
+            project_id: z.union([z.string(), z.number()]).describe("Project ID or identifier"),
+            sprint_id: z.number().describe("The sprint ID"),
+        },
+    }, async (params) => {
+        const result = await client.getAgileSprint(params.project_id, params.sprint_id);
+        return {
+            content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
+        };
+    });
+    server.registerTool("create_agile_sprint", {
+        description: "Create a new agile sprint for a project (requires redmine_agile plugin)",
+        inputSchema: {
+            project_id: z.union([z.string(), z.number()]).describe("Project ID or identifier"),
+            name: z.string().describe("Sprint name"),
+            status: z.string().optional().describe("Sprint status: open, active, closed"),
+            start_date: z.string().optional().describe("Start date (YYYY-MM-DD)"),
+            end_date: z.string().optional().describe("End date (YYYY-MM-DD)"),
+            description: z.string().optional().describe("Sprint description"),
+            sharing: z.string().optional().describe("Sharing level"),
+        },
+    }, async (params) => {
+        const { project_id, ...data } = params;
+        const result = await client.createAgileSprint(project_id, data);
+        return {
+            content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
+        };
+    });
+    server.registerTool("update_agile_sprint", {
+        description: "Update an existing agile sprint (requires redmine_agile plugin)",
+        inputSchema: {
+            project_id: z.union([z.string(), z.number()]).describe("Project ID or identifier"),
+            sprint_id: z.number().describe("The sprint ID to update"),
+            name: z.string().optional().describe("New sprint name"),
+            status: z.string().optional().describe("Sprint status: open, active, closed"),
+            start_date: z.string().optional().describe("Start date (YYYY-MM-DD)"),
+            end_date: z.string().optional().describe("End date (YYYY-MM-DD)"),
+            description: z.string().optional().describe("Sprint description"),
+            sharing: z.string().optional().describe("Sharing level"),
+        },
+    }, async (params) => {
+        const { project_id, sprint_id, ...data } = params;
+        const result = await client.updateAgileSprint(project_id, sprint_id, data);
+        return {
+            content: [{ type: "text", text: JSON.stringify(result ?? { success: true }, null, 2) }],
+        };
+    });
+    server.registerTool("delete_agile_sprint", {
+        description: "Delete an agile sprint (requires redmine_agile plugin)",
+        inputSchema: {
+            project_id: z.union([z.string(), z.number()]).describe("Project ID or identifier"),
+            sprint_id: z.number().describe("The sprint ID to delete"),
+        },
+    }, async (params) => {
+        const result = await client.deleteAgileSprint(params.project_id, params.sprint_id);
+        return {
+            content: [{ type: "text", text: JSON.stringify(result ?? { success: true }, null, 2) }],
+        };
+    });
+    // === AGILE DATA (Issue attributes) ===
+    server.registerTool("get_issue_agile_data", {
+        description: "Get agile data for an issue (position, story points, sprint) (requires redmine_agile plugin)",
+        inputSchema: {
+            issue_id: z.number().describe("The issue ID"),
+        },
+    }, async (params) => {
+        const result = await client.getIssueAgileData(params.issue_id);
+        return {
+            content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
+        };
+    });
+    server.registerTool("update_issue_agile_data", {
+        description: "Update agile data for an issue (position, story points, sprint assignment) (requires redmine_agile plugin)",
+        inputSchema: {
+            issue_id: z.number().describe("The issue ID"),
+            position: z.number().optional().describe("Position on the agile board"),
+            story_points: z.number().optional().describe("Story points for the issue"),
+            agile_sprint_id: z.number().nullable().optional().describe("Sprint ID to assign (null to unassign)"),
+        },
+    }, async (params) => {
+        const { issue_id, ...data } = params;
+        const result = await client.updateIssueAgileData(issue_id, data);
+        return {
+            content: [{ type: "text", text: JSON.stringify(result ?? { success: true }, null, 2) }],
+        };
+    });
+}

package/dist/tools/checklists.d.ts

@@ -0,0 +1,3 @@
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import type { RedmineClient } from "../redmine/client.js";
+export declare function registerChecklistsTools(server: McpServer, client: RedmineClient): void;

package/dist/tools/checklists.js

@@ -0,0 +1,65 @@
+import { z } from "zod";
+export function registerChecklistsTools(server, client) {
+    server.registerTool("list_checklists", {
+        description: "List all checklist items for an issue (requires redmine_checklists plugin)",
+        inputSchema: {
+            issue_id: z.number().describe("The issue ID to get checklists for"),
+        },
+    }, async (params) => {
+        const result = await client.listChecklists(params.issue_id);
+        return {
+            content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
+        };
+    });
+    server.registerTool("get_checklist", {
+        description: "Get a specific checklist item by ID (requires redmine_checklists plugin)",
+        inputSchema: {
+            checklist_id: z.number().describe("The checklist item ID"),
+        },
+    }, async (params) => {
+        const result = await client.getChecklist(params.checklist_id);
+        return {
+            content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
+        };
+    });
+    server.registerTool("create_checklist", {
+        description: "Create a new checklist item for an issue (requires redmine_checklists plugin)",
+        inputSchema: {
+            issue_id: z.number().describe("The issue ID to add the checklist item to"),
+            subject: z.string().describe("The checklist item text"),
+            is_done: z.boolean().optional().describe("Whether the item is completed (default: false)"),
+            position: z.number().optional().describe("Position in the checklist (1-based)"),
+        },
+    }, async (params) => {
+        const result = await client.createChecklist(params);
+        return {
+            content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
+        };
+    });
+    server.registerTool("update_checklist", {
+        description: "Update an existing checklist item (requires redmine_checklists plugin)",
+        inputSchema: {
+            checklist_id: z.number().describe("The checklist item ID to update"),
+            subject: z.string().optional().describe("New text for the checklist item"),
+            is_done: z.boolean().optional().describe("Mark as done/undone"),
+            position: z.number().optional().describe("New position in the checklist"),
+        },
+    }, async (params) => {
+        const { checklist_id, ...data } = params;
+        const result = await client.updateChecklist(checklist_id, data);
+        return {
+            content: [{ type: "text", text: JSON.stringify(result ?? { success: true }, null, 2) }],
+        };
+    });
+    server.registerTool("delete_checklist", {
+        description: "Delete a checklist item (requires redmine_checklists plugin)",
+        inputSchema: {
+            checklist_id: z.number().describe("The checklist item ID to delete"),
+        },
+    }, async (params) => {
+        const result = await client.deleteChecklist(params.checklist_id);
+        return {
+            content: [{ type: "text", text: JSON.stringify(result ?? { success: true }, null, 2) }],
+        };
+    });
+}

package/dist/tools/index.d.ts

@@ -1,9 +1,12 @@
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import type { RedmineClient } from "../redmine/client.js";
 export type ToolRegistrationFn = (server: McpServer, client: RedmineClient) => void;
+export declare const coreToolGroups: Record<string, ToolRegistrationFn>;
+export declare const pluginToolGroups: Record<string, ToolRegistrationFn>;
 export declare const toolGroups: Record<string, ToolRegistrationFn>;
 export type ToolGroup = keyof typeof toolGroups;
 export declare const ALL_GROUPS: ToolGroup[];
+export declare const PLUGIN_GROUPS: ToolGroup[];
 export declare function isValidToolGroup(group: string): group is ToolGroup;
 export declare function validateToolGroups(groups: string[]): ToolGroup[];
 export declare function resolveGroups(include?: string[], exclude?: string[]): ToolGroup[];

package/dist/tools/index.js

@@ -1,5 +1,7 @@
 import { registerAccountTools } from "./account.js";
 import { registerAdminTools } from "./admin.js";
+import { registerAgileTools } from "./agile.js";
+import { registerChecklistsTools } from "./checklists.js";
 import { registerCoreTools } from "./core.js";
 import { registerEnumerationsTools } from "./enumerations.js";
 import { registerFilesTools } from "./files.js";
@@ -10,7 +12,8 @@ import { registerRolesTools } from "./roles.js";
 import { registerSearchTools } from "./search.js";
 import { registerTimeTools } from "./time.js";
 import { registerWikiTools } from "./wiki.js";
-export const toolGroups = {
+// Core tool groups
+export const coreToolGroups = {
     core: registerCoreTools,
     metadata: registerMetadataTools,
     wiki: registerWikiTools,
@@ -24,7 +27,20 @@ export const toolGroups = {
     roles: registerRolesTools,
     admin: registerAdminTools,
 };
+// Plugin tool groups (require RedmineUP plugins to be installed)
+export const pluginToolGroups = {
+    plugin_checklists: registerChecklistsTools,
+    plugin_agile: registerAgileTools,
+};
+// All tool groups combined
+export const toolGroups = {
+    ...coreToolGroups,
+    ...pluginToolGroups,
+};
+// All groups including plugins are enabled by default
 export const ALL_GROUPS = Object.keys(toolGroups);
+// Plugin groups (for documentation purposes)
+export const PLUGIN_GROUPS = Object.keys(pluginToolGroups);
 export function isValidToolGroup(group) {
     return group in toolGroups;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pschroee/redmine-mcp",
-  "version": "0.3.3",
+  "version": "0.4.0",
   "description": "MCP server for Redmine - full API access with configurable tool groups",
   "type": "module",
   "bin": {