teamflect-mcp-server 1.0.13 → 1.0.14

package/dist/tools/goals.js

@@ -23,56 +23,56 @@ export function registerGoalTools(server, apiClient) {
     }).strict();
     server.registerTool("teamflect_get_goals", {
         title: "Get Goals",
-        description: `Retrieve a list of goals from Teamflect based on filters.
-
-This tool searches for goals matching the specified criteria. You can filter by user, search terms, labels, and date ranges. Results are paginated.
-
-Args:
-  - userOID (string, optional): Filter by user OID (UUID format)
-  - userUPN (string, optional): Filter by user UPN (email address)
-  - search (string, optional): Search term for title or owners
-  - selectedLabels (string, optional): Filter by selected labels
-  - limit (number, optional): Maximum number of items to return, between 1-500 (default: 200)
-  - skip (number, optional): Number of items to skip for pagination (default: 0)
-  - startDate (string, optional): Filter by start date (date format)
-  - endDate (string, optional): Filter by end date (date format)
-  - response_format ('markdown' | 'json', optional): Output format (default: 'markdown')
-
-Returns:
-  For JSON format: Structured data with schema:
-  {
-    "total": number,           // Total number of goals found
-    "count": number,           // Number of goals in this response
-    "offset": number,          // Current pagination offset
-    "goals": [
-      {
-        "goalId": string,
-        "title": string,
-        "description": string,
-        "status": string,
-        "goalType": string,
-        "startDate": string,
-        "dueDate": string,
-        "progress": {
-          "currentValue": number,
-          "targetValue": number,
-          "formatType": string
-        },
-        "owners": [{"displayName": string, "mail": string}],
-        "labels": [{"title": string}]
-      }
-    ],
-    "has_more": boolean,       // Whether more results are available
-    "next_offset": number       // Offset for next page (if has_more is true)
-  }
-
-Examples:
-  - Use when: "Get all active goals for john@example.com" -> params with status="Active", ownerEmail="john@example.com"
-  - Use when: "List goals due this month" -> params with dueDate filter
-  - Don't use when: You need a single goal by ID (use teamflect_get_goal instead)
-
-Error Handling:
-  - Returns "Error: Authentication failed" if API key is invalid
+        description: `Retrieve a list of goals from Teamflect based on filters.
+
+This tool searches for goals matching the specified criteria. You can filter by user, search terms, labels, and date ranges. Results are paginated.
+
+Args:
+  - userOID (string, optional): Filter by user OID (UUID format)
+  - userUPN (string, optional): Filter by user UPN (email address)
+  - search (string, optional): Search term for title or owners
+  - selectedLabels (string, optional): Filter by selected labels
+  - limit (number, optional): Maximum number of items to return, between 1-500 (default: 200)
+  - skip (number, optional): Number of items to skip for pagination (default: 0)
+  - startDate (string, optional): Filter by start date (date format)
+  - endDate (string, optional): Filter by end date (date format)
+  - response_format ('markdown' | 'json', optional): Output format (default: 'markdown')
+
+Returns:
+  For JSON format: Structured data with schema:
+  {
+    "total": number,           // Total number of goals found
+    "count": number,           // Number of goals in this response
+    "offset": number,          // Current pagination offset
+    "goals": [
+      {
+        "goalId": string,
+        "title": string,
+        "description": string,
+        "status": string,
+        "goalType": string,
+        "startDate": string,
+        "dueDate": string,
+        "progress": {
+          "currentValue": number,
+          "targetValue": number,
+          "formatType": string
+        },
+        "owners": [{"displayName": string, "mail": string}],
+        "labels": [{"title": string}]
+      }
+    ],
+    "has_more": boolean,       // Whether more results are available
+    "next_offset": number       // Offset for next page (if has_more is true)
+  }
+
+Examples:
+  - Use when: "Get all active goals for john@example.com" -> params with status="Active", ownerEmail="john@example.com"
+  - Use when: "List goals due this month" -> params with dueDate filter
+  - Don't use when: You need a single goal by ID (use teamflect_get_goal instead)
+
+Error Handling:
+  - Returns "Error: Authentication failed" if API key is invalid
   - Returns "Error: Rate limit exceeded" if too many requests (429 status)`,
         inputSchema: GetGoalsInputSchema,
         annotations: {
@@ -191,19 +191,19 @@ Error Handling:
     }).strict();
     server.registerTool("teamflect_get_goal", {
         title: "Get Goal by ID",
-        description: `Retrieve a single goal by its ID from Teamflect.
-
-This tool fetches detailed information about a specific goal including its progress, owners, labels, and comments.
-
-Args:
-  - goalId (string, required): The unique identifier of the goal
-  - response_format ('markdown' | 'json', optional): Output format (default: 'markdown')
-
-Returns:
-  Complete goal details including all fields and relationships.
-
-Error Handling:
-  - Returns "Error: Resource not found" if goalId doesn't exist
+        description: `Retrieve a single goal by its ID from Teamflect.
+
+This tool fetches detailed information about a specific goal including its progress, owners, labels, and comments.
+
+Args:
+  - goalId (string, required): The unique identifier of the goal
+  - response_format ('markdown' | 'json', optional): Output format (default: 'markdown')
+
+Returns:
+  Complete goal details including all fields and relationships.
+
+Error Handling:
+  - Returns "Error: Resource not found" if goalId doesn't exist
   - Returns "Error: Authentication failed" if API key is invalid`,
         inputSchema: GetGoalInputSchema,
         annotations: {
@@ -282,33 +282,33 @@ Error Handling:
     }).strict();
     server.registerTool("teamflect_create_goal", {
         title: "Create Goal",
-        description: `Create a new goal in Teamflect.
-
-This tool creates a new goal with the specified properties. You can set owners, labels, progress targets, and optionally link it to a parent goal.
-
-Args:
-  - title (string, required): Goal title (1-500 characters)
-  - description (string, optional): Goal description (max 5000 characters)
-  - goalType (string, optional): Goal type identifier (default: 'Self-development')
-  - startDate (string, required): Start date in ISO format (YYYY-MM-DD)
-  - dueDate (string, optional): Due date in ISO format (YYYY-MM-DD)
-  - goalCreatorUPNorId (string, required): Goal creator User Principal Name (UPN) or ID
-  - goalOwnerUPNorId (string, optional): Goal owner User Principal Name (UPN) or ID
-  - isPrivate (boolean, optional): Whether the goal is private
-  - progressFormatType (string, optional): Progress format type
-  - currencyCode (string, optional): Currency code for currency-based goals
-  - initialValue (number, optional): Initial progress value
-  - targetValue (number, optional): Target progress value
-  - parentGoalId (string, optional): Parent goal ID if this is a sub-goal
-  - sendNotificationToOwner (boolean, optional): Whether to send notification to the goal owner
-  - labelIds (array, optional): Array of label IDs to assign
-  - response_format ('markdown' | 'json', optional): Output format (default: 'markdown')
-
-Returns:
-  The created goal with all its details.
-
-Error Handling:
-  - Returns "Error: Bad request" if required fields are missing or invalid
+        description: `Create a new goal in Teamflect.
+
+This tool creates a new goal with the specified properties. You can set owners, labels, progress targets, and optionally link it to a parent goal.
+
+Args:
+  - title (string, required): Goal title (1-500 characters)
+  - description (string, optional): Goal description (max 5000 characters)
+  - goalType (string, optional): Goal type identifier (default: 'Self-development')
+  - startDate (string, required): Start date in ISO format (YYYY-MM-DD)
+  - dueDate (string, optional): Due date in ISO format (YYYY-MM-DD)
+  - goalCreatorUPNorId (string, required): Goal creator User Principal Name (UPN) or ID
+  - goalOwnerUPNorId (string, optional): Goal owner User Principal Name (UPN) or ID
+  - isPrivate (boolean, optional): Whether the goal is private
+  - progressFormatType (string, optional): Progress format type
+  - currencyCode (string, optional): Currency code for currency-based goals
+  - initialValue (number, optional): Initial progress value
+  - targetValue (number, optional): Target progress value
+  - parentGoalId (string, optional): Parent goal ID if this is a sub-goal
+  - sendNotificationToOwner (boolean, optional): Whether to send notification to the goal owner
+  - labelIds (array, optional): Array of label IDs to assign
+  - response_format ('markdown' | 'json', optional): Output format (default: 'markdown')
+
+Returns:
+  The created goal with all its details.
+
+Error Handling:
+  - Returns "Error: Bad request" if required fields are missing or invalid
   - Returns "Error: Permission denied" if you don't have permission to create goals`,
         inputSchema: CreateGoalInputSchema,
         annotations: {
@@ -390,24 +390,24 @@ Error Handling:
     }).strict();
     server.registerTool("teamflect_update_goal_progress", {
         title: "Update Goal Progress",
-        description: `Update the progress value of a goal in Teamflect.
-
-This tool updates the current progress value for a goal. You can optionally include a comment, update the status, and specify who is making the update.
-
-Args:
-  - goalId (string, required): The ID of the goal to update
-  - currentValue (number, required): New current progress value
-  - comment (string, optional): Optional comment about the progress update (max 1000 characters)
-  - status (string, optional): Optional status update. Possible values: 'On track', 'At risk', 'Off track', 'Closed'
-  - goalUpdater (string, optional): Who will be seen as the updater. 'Owner' (default) or 'System'
-  - goalUpdaterSystemName (string, optional): Name of the updater when goalUpdater is 'System'
-  - response_format ('markdown' | 'json', optional): Output format (default: 'markdown')
-
-Returns:
-  The updated goal with the new progress value.
-
-Error Handling:
-  - Returns "Error: Resource not found" if goalId doesn't exist
+        description: `Update the progress value of a goal in Teamflect.
+
+This tool updates the current progress value for a goal. You can optionally include a comment, update the status, and specify who is making the update.
+
+Args:
+  - goalId (string, required): The ID of the goal to update
+  - currentValue (number, required): New current progress value
+  - comment (string, optional): Optional comment about the progress update (max 1000 characters)
+  - status (string, optional): Optional status update. Possible values: 'On track', 'At risk', 'Off track', 'Closed'
+  - goalUpdater (string, optional): Who will be seen as the updater. 'Owner' (default) or 'System'
+  - goalUpdaterSystemName (string, optional): Name of the updater when goalUpdater is 'System'
+  - response_format ('markdown' | 'json', optional): Output format (default: 'markdown')
+
+Returns:
+  The updated goal with the new progress value.
+
+Error Handling:
+  - Returns "Error: Resource not found" if goalId doesn't exist
   - Returns "Error: Bad request" if currentValue is invalid`,
         inputSchema: UpdateGoalProgressInputSchema,
         annotations: {
@@ -467,21 +467,21 @@ Error Handling:
     }).strict();
     server.registerTool("teamflect_comment_goal", {
         title: "Comment on Goal",
-        description: `Add a comment to a goal in Teamflect.
-
-This tool adds a comment to the specified goal. Comments are useful for tracking discussions and updates about goal progress.
-
-Args:
-  - goalId (string, required): The ID of the goal to comment on
-  - commenterIdOrUPN (string, required): Commenter ID (UUID) or UPN (email address)
-  - commentText (string, required): Comment text (1-1000 characters)
-  - response_format ('markdown' | 'json', optional): Output format (default: 'markdown')
-
-Returns:
-  The goal with the new comment added.
-
-Error Handling:
-  - Returns "Error: Resource not found" if goalId doesn't exist
+        description: `Add a comment to a goal in Teamflect.
+
+This tool adds a comment to the specified goal. Comments are useful for tracking discussions and updates about goal progress.
+
+Args:
+  - goalId (string, required): The ID of the goal to comment on
+  - commenterIdOrUPN (string, required): Commenter ID (UUID) or UPN (email address)
+  - commentText (string, required): Comment text (1-1000 characters)
+  - response_format ('markdown' | 'json', optional): Output format (default: 'markdown')
+
+Returns:
+  The goal with the new comment added.
+
+Error Handling:
+  - Returns "Error: Resource not found" if goalId doesn't exist
   - Returns "Error: Bad request" if commentText is empty or too long`,
         inputSchema: CommentGoalInputSchema,
         annotations: {

package/dist/tools/recognitions.js

@@ -14,19 +14,19 @@ export function registerRecognitionTools(server, apiClient) {
     }).strict();
     server.registerTool("teamflect_get_recognition", {
         title: "Get Recognition by ID",
-        description: `Retrieve a single recognition by its ID from Teamflect.
-
-This tool fetches detailed information about a specific recognition including its badge, recipients, and description.
-
-Args:
-  - recognitionId (string, required): The unique identifier of the recognition
-  - response_format ('markdown' | 'json', optional): Output format (default: 'markdown')
-
-Returns:
-  Complete recognition details including badge information and recipients.
-
-Error Handling:
-  - Returns "Error: Resource not found" if recognitionId doesn't exist
+        description: `Retrieve a single recognition by its ID from Teamflect.
+
+This tool fetches detailed information about a specific recognition including its badge, recipients, and description.
+
+Args:
+  - recognitionId (string, required): The unique identifier of the recognition
+  - response_format ('markdown' | 'json', optional): Output format (default: 'markdown')
+
+Returns:
+  Complete recognition details including badge information and recipients.
+
+Error Handling:
+  - Returns "Error: Resource not found" if recognitionId doesn't exist
   - Returns "Error: Authentication failed" if API key is invalid`,
         inputSchema: GetRecognitionInputSchema,
         annotations: {
@@ -149,43 +149,43 @@ Error Handling:
     }).strict();
     server.registerTool("teamflect_search_recognitions", {
         title: "Search Recognitions",
-        description: `Search for recognitions in Teamflect based on filters.
-
-This tool searches for recognitions matching the specified criteria. You can filter by recipients, title, and timestamps.
-
-Args:
-  - recipientsIdsOrUPNS (array, optional): Filter by recipient IDs or UPNs (array of strings)
-  - title (string, optional): Filter by recognition title
-  - updated (string, optional): Filter by updated timestamp
-  - created (string, optional): Filter by created timestamp
-  - response_format ('markdown' | 'json', optional): Output format (default: 'markdown')
-
-Returns:
-  For JSON format: Structured data with schema:
-  {
-    "total": number,
-    "count": number,
-    "offset": number,
-    "recognitions": [
-      {
-        "id": string,
-        "description": string,
-        "createdAt": string,
-        "isPrivate": boolean,
-        "badge": {"id": string, "title": string, "description": string},
-        "recipients": [{"displayName": string, "jobTitle": string, "mail": string}]
-      }
-    ],
-    "has_more": boolean,
-    "next_offset": number
-  }
-
-Examples:
-  - Use when: "Get all recognitions for john@example.com" -> params with recipientEmail="john@example.com"
-  - Use when: "List public recognitions this month" -> params with isPrivate=false and date filters
-
-Error Handling:
-  - Returns "Error: Authentication failed" if API key is invalid
+        description: `Search for recognitions in Teamflect based on filters.
+
+This tool searches for recognitions matching the specified criteria. You can filter by recipients, title, and timestamps.
+
+Args:
+  - recipientsIdsOrUPNS (array, optional): Filter by recipient IDs or UPNs (array of strings)
+  - title (string, optional): Filter by recognition title
+  - updated (string, optional): Filter by updated timestamp
+  - created (string, optional): Filter by created timestamp
+  - response_format ('markdown' | 'json', optional): Output format (default: 'markdown')
+
+Returns:
+  For JSON format: Structured data with schema:
+  {
+    "total": number,
+    "count": number,
+    "offset": number,
+    "recognitions": [
+      {
+        "id": string,
+        "description": string,
+        "createdAt": string,
+        "isPrivate": boolean,
+        "badge": {"id": string, "title": string, "description": string},
+        "recipients": [{"displayName": string, "jobTitle": string, "mail": string}]
+      }
+    ],
+    "has_more": boolean,
+    "next_offset": number
+  }
+
+Examples:
+  - Use when: "Get all recognitions for john@example.com" -> params with recipientEmail="john@example.com"
+  - Use when: "List public recognitions this month" -> params with isPrivate=false and date filters
+
+Error Handling:
+  - Returns "Error: Authentication failed" if API key is invalid
   - Returns "Error: Rate limit exceeded" if too many requests`,
         inputSchema: SearchRecognitionsInputSchema,
         annotations: {
@@ -340,23 +340,23 @@ Error Handling:
     }).strict();
     server.registerTool("teamflect_create_recognition", {
         title: "Create Recognition",
-        description: `Create a new recognition in Teamflect.
-
-This tool creates a recognition (award/badge) for one or more recipients. Recognitions can be public or private.
-
-Args:
-  - senderIdOrUPN (string, required): Sender ID or User Principal Name (email or GUID)
-  - recipientsIdsOrUPNS (array, required): Array of recipient IDs or UPNs (email addresses or GUIDs, at least one)
-  - badgeTitle (string, required): Badge title
-  - isPrivate (boolean, optional): Whether the recognition is private
-  - description (string, required): Recognition description
-  - response_format ('markdown' | 'json', optional): Output format (default: 'markdown')
-
-Returns:
-  The created recognition(s) with all details.
-
-Error Handling:
-  - Returns "Error: Bad request" if required fields are missing or invalid
+        description: `Create a new recognition in Teamflect.
+
+This tool creates a recognition (award/badge) for one or more recipients. Recognitions can be public or private.
+
+Args:
+  - senderIdOrUPN (string, required): Sender ID or User Principal Name (email or GUID)
+  - recipientsIdsOrUPNS (array, required): Array of recipient IDs or UPNs (email addresses or GUIDs, at least one)
+  - badgeTitle (string, required): Badge title
+  - isPrivate (boolean, optional): Whether the recognition is private
+  - description (string, required): Recognition description
+  - response_format ('markdown' | 'json', optional): Output format (default: 'markdown')
+
+Returns:
+  The created recognition(s) with all details.
+
+Error Handling:
+  - Returns "Error: Bad request" if required fields are missing or invalid
   - Returns "Error: Permission denied" if you don't have permission to create recognitions`,
         inputSchema: CreateRecognitionInputSchema,
         annotations: {

package/package.json

@@ -1,63 +1,63 @@
-{
-  "name": "teamflect-mcp-server",
-  "version": "1.0.13",
-  "description": "MCP server for Teamflect API integration",
-  "type": "module",
-  "main": "dist/index.js",
-  "bin": {
-    "teamflect-mcp-server": "dist/index.js"
-  },
-  "scripts": {
-    "start": "node dist/index.js",
-    "dev": "tsx watch src/index.ts",
-    "build": "tsc",
-    "clean": "rm -rf dist",
-    "prepublishOnly": "npm run build",
-    "test": "node test-all-tools.js",
-    "test:watch": "node test-all-tools.js --watch",
-    "test:coverage": "node test-all-tools.js --coverage",
-    "test:curl": "powershell -ExecutionPolicy Bypass -File test-all-tools-curl.ps1"
-  },
-  "engines": {
-    "node": ">=18"
-  },
-  "dependencies": {
-    "@modelcontextprotocol/sdk": "^1.6.1",
-    "axios": "^1.7.9",
-    "dotenv": "^17.2.3",
-    "express": "^4.18.2",
-    "zod": "^3.23.8"
-  },
-  "devDependencies": {
-    "@types/express": "^4.17.25",
-    "@types/node": "^20.19.30",
-    "tsx": "^4.19.2",
-    "typescript": "^5.3.3"
-  },
-  "keywords": [
-    "mcp",
-    "teamflect",
-    "performance-management",
-    "goals",
-    "feedback",
-    "api",
-    "integration",
-    "claude",
-    "cursor"
-  ],
-  "author": "",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://Mohamedahmed@dev.azure.com/Mohamedahmed/AIMentorHub/_git/AIMentorHub.Teamflect.MCPServer"
-  },
-  "homepage": "https://dev.azure.com/Mohamedahmed/AIMentorHub/_git/AIMentorHub.Teamflect.MCPServer",
-  "bugs": {
-    "url": "https://dev.azure.com/Mohamedahmed/AIMentorHub/_git/AIMentorHub.Teamflect.MCPServer/issues"
-  },
-  "files": [
-    "dist",
-    "README.md",
-    ".env.example"
-  ]
-}
+{
+  "name": "teamflect-mcp-server",
+  "version": "1.0.14",
+  "description": "MCP server for Teamflect API integration",
+  "type": "module",
+  "main": "dist/index.js",
+  "bin": {
+    "teamflect-mcp-server": "dist/index.js"
+  },
+  "scripts": {
+    "start": "node dist/index.js",
+    "dev": "tsx watch src/index.ts",
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run build",
+    "test": "node test-all-tools.js",
+    "test:watch": "node test-all-tools.js --watch",
+    "test:coverage": "node test-all-tools.js --coverage",
+    "test:curl": "powershell -ExecutionPolicy Bypass -File test-all-tools-curl.ps1"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.6.1",
+    "axios": "^1.7.9",
+    "dotenv": "^17.2.3",
+    "express": "^4.18.2",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.25",
+    "@types/node": "^20.19.30",
+    "tsx": "^4.19.2",
+    "typescript": "^5.3.3"
+  },
+  "keywords": [
+    "mcp",
+    "teamflect",
+    "performance-management",
+    "goals",
+    "feedback",
+    "api",
+    "integration",
+    "claude",
+    "cursor"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://Mohamedahmed@dev.azure.com/Mohamedahmed/AIMentorHub/_git/AIMentorHub.Teamflect.MCPServer"
+  },
+  "homepage": "https://dev.azure.com/Mohamedahmed/AIMentorHub/_git/AIMentorHub.Teamflect.MCPServer",
+  "bugs": {
+    "url": "https://dev.azure.com/Mohamedahmed/AIMentorHub/_git/AIMentorHub.Teamflect.MCPServer/issues"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    ".env.example"
+  ]
+}