targetprocess-mcp-server 2.2.3 → 2.2.4

package/README.md

@@ -46,6 +46,7 @@ Features
 - `get_not_covered_user_stories_in_feature` — Get user stories in a feature not yet covered by tests, includes `covered` field based on "Test Automation" custom field (id)
 
 Cards — Read
+- `get_card_status` — Get EntityState, TeamState, and assigned teams for a card (id, optional resourceType: UserStory | Bug | Feature, default: UserStory)
 - `get_bug_content` — Fetch full content of a bug by ID (id)
 - `get_user_story_content` — Fetch full content of a user story by ID (id)
 - `get_bug_comments` — Get comments on a bug (id, optional results)

package/build/index.js

@@ -4,6 +4,7 @@ import { z } from "zod";
 import { JSDOM } from "jsdom";
 import { TpClient } from "./tp.js";
 import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import { config } from "./config.js";
 const server = new McpServer({
     name: "tp",
     version: "1.0.0"
@@ -374,6 +375,7 @@ server.registerTool('search_tp_cards', {
             title: item.Name,
             id: item.Id,
             description: descriptionText,
+            url: `${config.tp.url}/entity/${item.Id}`,
         };
     });
     return {
@@ -598,11 +600,13 @@ server.registerTool('create_bug_based_on_card', {
     title: 'Create a new bug card based on provided card id',
     description: `Create a new bug card based on provided card id that summarizes the problem in concise, descriptive manner answering questions What? Where? When?, and content explaining what happened in detail. 
       NOTE: this tool requires a user story or bug card as a reference (i.e. card ID).
-      CRITICAL WORKFLOW: Before calling this tool, you MUST follow these steps: 
+      CRITICAL WORKFLOW: Before calling this tool, you MUST follow these steps:
         1) IF you already have user story or bug card content, proceed to step 3 skipping step 2;
         2) ELSE call "get_user_story_content" tool or "get_bug_content" tool to get user story or bug card content;
         3) format the new bug inside html <div> tags with Issue Description, Steps to Reproduce, Expected Behavior, Actual Behavior sections (note: section titles should be wrapped in <h3> tags, e.g. <h3>Issue Description</h3>);
-        4) add a comment to the card with created bug Id and its Title`,
+        4) IF the user specified a team by name (not ID), call "get_teams" to find the matching team and use its ID as teamId;
+        5) IF the user specified a project by name (not ID), call "get_projects" to find the matching project and use its ID as projectId;
+        6) add a comment to the card with created bug Id and its Title`,
     inputSchema: {
         title: z.string()
             .describe('Bug card title that summarizes the problem in concise, descriptive, and actionable manner, enabling a developer to understand the issue without opening the report'),
@@ -635,10 +639,10 @@ server.registerTool('create_bug_based_on_card', {
             .describe('Where the bug was found, defaults to "Manual QA"'),
         projectId: z.string()
             .optional()
-            .describe('Optional Project ID — defaults to TP_PROJECT_ID from config'),
+            .describe('Optional Project ID — if user gave a project name, resolve it via "get_projects" first; defaults to TP_PROJECT_ID from config'),
         teamId: z.string()
             .optional()
-            .describe('Optional Team ID — defaults to TP_TEAM_ID from config'),
+            .describe('Optional Team ID — if user gave a team name, resolve it via "get_teams" first; defaults to TP_TEAM_ID from config'),
     },
 }, async ({ title, card, bugContent, origin, projectId, teamId }) => {
     const bugResponse = await tp.createBug({ title, card, bugContent, origin, projectId, teamId });
@@ -662,7 +666,9 @@ server.registerTool('create_bug', {
     description: `Create a new bug card that summarizes the problem in concise, descriptive manner answering questions "What? Where? When?" and content explaining what happened in detail.
       NOTE: this tool does not require a user story or bug card reference.
       CRITICAL WORKFLOW: Before calling this tool, you MUST follow these steps:
-        1) format the new bug inside html <div> tags with Issue Description, Steps to Reproduce, Expected Behavior, Actual Behavior sections (note: section titles should be wrapped in <h3> tags, e.g. <h3>Issue Description</h3>);`,
+        1) format the new bug inside html <div> tags with Issue Description, Steps to Reproduce, Expected Behavior, Actual Behavior sections (note: section titles should be wrapped in <h3> tags, e.g. <h3>Issue Description</h3>, step to reproduce should be wrapped in <ol>);
+        2) IF the user specified a team by name (not ID), call "get_teams" to find the matching team and use its ID as teamId;
+        3) IF the user specified a project by name (not ID), call "get_projects" to find the matching project and use its ID as projectId;`,
     inputSchema: {
         title: z.string()
             .describe('Bug card title that summarizes the problem in concise, descriptive, and actionable manner, enabling a developer to understand the issue without opening the report'),
@@ -684,10 +690,10 @@ server.registerTool('create_bug', {
             .describe('Where the bug was found, defaults to "Manual QA"'),
         projectId: z.string()
             .optional()
-            .describe('Optional Project ID — defaults to TP_PROJECT_ID from config'),
+            .describe('Optional Project ID — if user gave a project name, resolve it via "get_projects" first; defaults to TP_PROJECT_ID from config'),
         teamId: z.string()
             .optional()
-            .describe('Optional Team ID — defaults to TP_TEAM_ID from config'),
+            .describe('Optional Team ID — if user gave a team name, resolve it via "get_teams" first; defaults to TP_TEAM_ID from config'),
     },
 }, async ({ title, bugContent, origin, projectId, teamId }) => {
     const bugResponse = await tp.createBugOnly({ title, bugContent, origin, projectId, teamId });
@@ -1238,63 +1244,44 @@ server.registerTool('add_test_cases_to_test_plan', {
             }]
     };
 });
-server.registerTool('add_attached_file_to_card', {
-    title: 'Attach a file to a TP card',
-    description: `Upload and attach a file to a Targetprocess entity (UserStory, Bug, Feature, etc.) by its ID.
-        1) fileContent + fileName — provide base64-encoded file content and a filename (use this when the file was uploaded directly into the chat)
-      WORKFLOW for chat-uploaded files: run \`base64 <path>\` via Bash to get the encoded content, then call this tool with fileContent + fileName.`,
+server.registerTool('get_card_status', {
+    title: 'Get card status',
+    description: 'Get the EntityState, TeamState, and assigned teams for a TP card (UserStory, Bug, or Feature) by ID',
     inputSchema: {
-        generalId: z.string()
+        id: z.string()
             .min(5)
             .max(6)
-            .describe('TP entity ID to attach the file to (e.g. 145789)'),
-        filePath: z.string()
-            .optional()
-            .describe('Absolute path to a local file (mode 1). Mutually exclusive with fileContent/fileName.'),
-        fileContent: z.string()
-            .optional()
-            .describe('Base64-encoded file content (mode 2). Must be paired with fileName.'),
-        fileName: z.string()
+            .describe('TP card ID (e.g. 146055)'),
+        resourceType: z.enum(['UserStory', 'Bug', 'Feature'])
+            .default('UserStory')
             .optional()
-            .describe('Filename including extension, required when using fileContent (e.g. screenshot.png).'),
+            .describe('Type of the TP card — UserStory, Bug, or Feature (default: UserStory)'),
     },
-}, async ({ generalId, filePath, fileContent, fileName }) => {
-    try {
-        if (!filePath && (!fileContent || !fileName)) {
-            return {
-                content: [{
-                        type: 'text',
-                        text: 'Provide either filePath, or both fileContent and fileName.'
-                    }]
-            };
-        }
-        const source = filePath
-            ? { filePath }
-            : { fileContent: fileContent, fileName: fileName };
-        const result = await tp.addAttachedFile(generalId, source);
-        if (!result) {
-            return {
-                content: [{
-                        type: 'text',
-                        text: `Failed to attach file to card id: ${generalId}`
-                    }]
-            };
-        }
+}, async ({ id, resourceType = 'UserStory' }) => {
+    const response = await tp.getCardStatus(id, resourceType);
+    if (!response) {
         return {
             content: [{
                     type: 'text',
-                    text: result
-                }]
+                    text: `Failed to get card status for ${resourceType} id: ${id}`
+                }],
         };
     }
-    catch (error) {
+    const items = response.items || [];
+    if (items.length === 0) {
         return {
             content: [{
                     type: 'text',
-                    text: `Error attaching file to card ${generalId}: ${error}`
-                }]
+                    text: `No status data found for ${resourceType} id: ${id}`,
+                }],
         };
     }
+    return {
+        content: [{
+                type: 'text',
+                text: JSON.stringify(items[0])
+            }],
+    };
 });
 async function main() {
     const transport = new StdioServerTransport();

package/build/tp.js

@@ -15,8 +15,8 @@ export class TpClient {
     }
     params(params) {
         let _url = this.baseUrl + (params.apiVersion || this.v1);
-        for (const [key, value] of Object.entries(params.pathParam)) {
-            _url += value ? `/${key}/${value}` : `/${key}`;
+        for (const segment of params.pathParam) {
+            _url += `/${segment}`;
         }
         let _urlParams = [];
         for (const [key, value] of Object.entries(params.param)) {
@@ -83,21 +83,21 @@ export class TpClient {
     }
     async getUserStory(userStoryId) {
         const response = await this.get({
-            pathParam: { "userStories": userStoryId },
+            pathParam: ["userStories", userStoryId],
             param: { "format": "json" },
         });
         return response;
     }
     async getBug(bugId) {
         const response = await this.get({
-            pathParam: { "bugs": bugId },
+            pathParam: ["bugs", bugId],
             param: { "format": "json" }
         });
         return response;
     }
     async getFeature(featureId) {
         const response = await this.get({
-            pathParam: { "features": featureId },
+            pathParam: ["features", featureId],
             param: { "format": "json" }
         });
         return response;
@@ -126,7 +126,7 @@ export class TpClient {
             };
         }
         return this.post({
-            pathParam: { "bugs": '' },
+            pathParam: ["bugs"],
             param: { "format": "json" },
         }, bug);
     }
@@ -149,7 +149,7 @@ export class TpClient {
             "Description": bugContent,
         };
         return this.post({
-            pathParam: { "bugs": '' },
+            pathParam: ["bugs"],
             param: { "format": "json" },
         }, bug);
     }
@@ -166,7 +166,7 @@ export class TpClient {
         if (releaseId)
             userStory["Release"] = { "Id": releaseId };
         return this.post({
-            pathParam: { "UserStories": '' },
+            pathParam: ["UserStories"],
             param: { "format": "json" },
         }, userStory);
     }
@@ -183,7 +183,7 @@ export class TpClient {
         if (releaseId)
             feature["Release"] = { "Id": releaseId };
         return this.post({
-            pathParam: { "Features": '' },
+            pathParam: ["Features"],
             param: { "format": "json" },
         }, feature);
     }
@@ -209,7 +209,7 @@ export class TpClient {
             "Description": bugContent,
         };
         return this.post({
-            pathParam: { "bugs": '' },
+            pathParam: ["bugs"],
             param: { "format": "json" },
         }, bug);
     }
@@ -223,7 +223,7 @@ export class TpClient {
                 }],
         };
         return this.post({
-            pathParam: { "testCases": '' },
+            pathParam: ["testCases"],
             param: { "format": "json" },
         }, testCase);
     }
@@ -260,7 +260,7 @@ export class TpClient {
         if (options?.endDate)
             testPlan["EndDate"] = options.endDate;
         return this.post({
-            pathParam: { "testPlans": '' },
+            pathParam: ["testPlans"],
             param: { "format": "json" },
         }, testPlan);
     }
@@ -275,7 +275,7 @@ export class TpClient {
             },
         };
         return this.post({
-            pathParam: { "comments": '' },
+            pathParam: ["comments"],
             param: { "format": "json" },
         }, commentData);
     }
@@ -286,16 +286,13 @@ export class TpClient {
             "TestCase": { "Id": testCaseId },
         };
         return this.post({
-            pathParam: { "testSteps": '' },
+            pathParam: ["testSteps"],
             param: { "format": "json" },
         }, testStepData);
     }
     async getBugComments(bugId, results = 25) {
         const response = await this.get({
-            pathParam: {
-                "Bugs": bugId,
-                "Comments": "",
-            },
+            pathParam: ["Bugs", bugId, "Comments"],
             param: {
                 "format": "json",
                 "take": results,
@@ -305,10 +302,7 @@ export class TpClient {
     }
     async getUserStoryComments(userStoryId, results = 25) {
         const response = await this.get({
-            pathParam: {
-                "UserStories": userStoryId,
-                "Comments": "",
-            },
+            pathParam: ["UserStories", userStoryId, "Comments"],
             param: {
                 "format": "json",
                 "take": results,
@@ -318,7 +312,7 @@ export class TpClient {
     }
     async searchContainsNameText({ text, entityType }) {
         return this.get({
-            pathParam: { [entityType]: '' },
+            pathParam: [entityType],
             param: {
                 "format": "json",
                 "take": "25",
@@ -329,7 +323,7 @@ export class TpClient {
     }
     async searchContainsDescriptionText({ text, entityType }) {
         return this.get({
-            pathParam: { [entityType]: '' },
+            pathParam: [entityType],
             param: {
                 "where": `Description contains '${text}' and EntityState.Name eq 'Done'`,
                 "format": "json",
@@ -339,7 +333,7 @@ export class TpClient {
     }
     async getCurrentReleases() {
         return this.get({
-            pathParam: { "Releases": '' },
+            pathParam: ["Releases"],
             param: {
                 "format": "json",
                 "where": `IsCurrent eq 'true'`,
@@ -349,7 +343,7 @@ export class TpClient {
     async getReleaseUserStories({ name, results = 50, withDescription = false }) {
         const includeFilter = withDescription ? "[Name, Description, Id]" : "[Name, Id]";
         return this.get({
-            pathParam: { "UserStories": '' },
+            pathParam: ["UserStories"],
             param: {
                 "format": "json",
                 "take": results,
@@ -361,11 +355,11 @@ export class TpClient {
     async getReleaseOpenUserStories({ name, results = 100, withDescription = false }) {
         const includeFilter = withDescription ? "[Name, Description, Id]" : "[Name, Id]";
         return this.get({
-            pathParam: { "UserStories": '' },
+            pathParam: ["UserStories"],
             param: {
                 "format": "json",
                 "take": results,
-                "where": `Release.Name eq '${name}' and EntityState.Name ne 'Closed' and EntityState.Name ne 'Done' and EntityState.Name ne 'Passed Dev01  QA' and EntityState.Name ne 'Ready to Deploy to prod'`,
+                "where": `Release.Name eq '${name}' and EntityState.Name ne 'Closed' and EntityState.Name ne 'Done' and EntityState.Name ne 'Passed Dev01  QA' and EntityState.Name ne 'Ready to Deploy to prod'`,
                 "include": includeFilter,
             }
         });
@@ -373,11 +367,11 @@ export class TpClient {
     async getReleaseOpenBugs({ name, results = 200, withDescription = false }) {
         const includeFilter = withDescription ? "[Name, Description, Id]" : "[Name, Id]";
         return this.get({
-            pathParam: { "Bugs": '' },
+            pathParam: ["Bugs"],
             param: {
                 "format": "json",
                 "take": results,
-                "where": `Release.Name eq '${name}' and EntityState.Name ne 'Closed' and EntityState.Name ne 'Done' and EntityState.Name ne 'Passed Dev01  QA' and EntityState.Name ne 'Ready to Deploy to prod'`,
+                "where": `Release.Name eq '${name}' and EntityState.Name ne 'Closed' and EntityState.Name ne 'Done' and EntityState.Name ne 'Passed Dev01  QA' and EntityState.Name ne 'Ready to Deploy to prod'`,
                 "include": includeFilter,
             }
         });
@@ -385,7 +379,7 @@ export class TpClient {
     async getReleaseBugs({ name, results = 100, withDescription = false }) {
         const includeFilter = withDescription ? "[Name, Description, Id]" : "[Name, Id]";
         return this.get({
-            pathParam: { "Bugs": '' },
+            pathParam: ["Bugs"],
             param: {
                 "format": "json",
                 "take": results,
@@ -397,7 +391,7 @@ export class TpClient {
     async getReleaseFeatures({ name, results = 50, withDescription = false }) {
         const includeFilter = withDescription ? "[Name, Description, Id]" : "[Name, Id]";
         return this.get({
-            pathParam: { "Features": '' },
+            pathParam: ["Features"],
             param: {
                 "format": "json",
                 "take": results,
@@ -408,7 +402,7 @@ export class TpClient {
     }
     async getFeatureUserStories(featureId) {
         return this.get({
-            pathParam: { "features": '' },
+            pathParam: ["features"],
             param: {
                 "format": "json",
                 "where": `(id==${featureId})`,
@@ -419,7 +413,7 @@ export class TpClient {
     }
     async getUserStoriesIdsByFeatureId(featureId) {
         return this.get({
-            pathParam: { "userstories": '' },
+            pathParam: ["userstories"],
             param: {
                 "format": "json",
                 "where": `(Feature.Id==${featureId})`,
@@ -430,7 +424,7 @@ export class TpClient {
     }
     async getUserStoryTestPlan(userStoryId) {
         return this.get({
-            pathParam: { "userStories": userStoryId },
+            pathParam: ["userStories", userStoryId],
             param: {
                 "format": "json",
                 "select": `{id,storyName:name,linkedtestplan}`,
@@ -439,18 +433,9 @@ export class TpClient {
         });
     }
     async getCardTestPlan(cardId, resourceType = 'UserStory') {
-        let requestPath = "";
-        if (resourceType === 'UserStory') {
-            requestPath = "userStories";
-        }
-        else if (resourceType === 'Bug') {
-            requestPath = "bugs";
-        }
-        else if (resourceType === 'Feature') {
-            requestPath = "features";
-        }
+        const pathMap = { UserStory: "userStories", Bug: "bugs", Feature: "features" };
         return this.get({
-            pathParam: { [requestPath]: cardId },
+            pathParam: [pathMap[resourceType], cardId],
             param: {
                 "format": "json",
                 "select": `{id,linkedtestplan}`,
@@ -459,38 +444,44 @@ export class TpClient {
     }
     async getTestPlanTestCases(testPlanId) {
         return this.get({
-            pathParam: {
-                "testPlans": testPlanId,
-                "testcases": "",
-            },
+            pathParam: ["testPlans", testPlanId, "testcases"],
             param: { "format": "json" },
         });
     }
     async getTestCaseSteps(testCaseId) {
         return this.get({
-            pathParam: {
-                "testCases": testCaseId,
-                "teststeps": "",
-            },
-            param: { "format": "json", },
+            pathParam: ["testCases", testCaseId, "teststeps"],
+            param: { "format": "json" },
         });
     }
     async getProjects() {
         return this.get({
-            pathParam: { "Projects": '' },
+            pathParam: ["Projects"],
             param: { "format": "json" },
         });
     }
     async getTeams() {
         return this.get({
-            pathParam: { "Teams": '' },
+            pathParam: ["Teams"],
             param: { "format": "json" },
         });
     }
+    async getCardStatus(cardId, resourceType = 'UserStory') {
+        const pathMap = { UserStory: 'userStory', Bug: 'bug', Feature: 'feature' };
+        return this.get({
+            pathParam: [pathMap[resourceType]],
+            param: {
+                "select": `{Project:{Project.Id},EntityState:{EntityState.Id,EntityState.Name,EntityState.NextStates,EntityState.Workflow.Id as WorkflowId},TeamState:{ResponsibleTeam.Id,Team:{ResponsibleTeam.Team.Id,ResponsibleTeam.Team.Name},EntityState:{ResponsibleTeam.EntityState.Id,ResponsibleTeam.EntityState.Name,ResponsibleTeam.EntityState.Workflow.Id as WorkflowId}},AssignedTeams.Select({TeamAssignmentId:Id,Id:Team.Id,Name:Team.Name}) as Teams}`,
+                "where": `(id=${cardId})`,
+                "take": "1",
+            },
+            apiVersion: this.v2
+        });
+    }
     async getContext() {
         return this.get({
-            pathParam: { "Context": '' },
-            param: { "format": "json", }
+            pathParam: ["Context"],
+            param: { "format": "json" }
         });
     }
     async addAttachedFile(generalId, source) {

package/package.json

@@ -25,7 +25,7 @@
   "engines": {
     "node": ">=20.x"
   },
-  "version": "2.2.3",
+  "version": "2.2.4",
   "description": "MCP server for Tartget Process",
   "main": "build/index.js",
   "keywords": [