Skip to main content

WorkZappy MCP Server

The WorkZappy Model Context Protocol (MCP) Server brings a significant benefit to your workflow by integrating your WorkZappy issue management system directly with Large Language Models (LLMs). This allows you and your team to interact with and manage WorkZappy issues using simple, natural language commands without leaving your development environment.

1. Installation and Configuration​

To get started, you need to configure the server with your LLM Client application.

  1. Obtain an API Key: First, you must create or retrieve a Personal API Key for your team. You can do this by visiting the WorkZappy API Key settings page: https://app.workzappy.com/setting/api-key.
  2. Server Configuration: Add the server configuration details, including your new API key, to your LLM Client setting.
{
  "mcpServers": {
    "workzappy-mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "workzappy-mcp-server"
      ],
      "env":{
        "CLIENT_ID":"you client id",
        "SECRET":"you client secret"
      }
    }
  }
}
note

Don't forget to replace the value of CLIENT_ID and SECRET.

2. Available Tools and Functionality​

The server provides a set of tools to interact with WorkZappy. Below is a detailed description of each tool, its parameters, and how to use it.

1. search_all_issues

  • Description: Performs a comprehensive search for issues using a variety of filters.
  • Example: "Find all in progress issues" will use this tool to locate issues where the status is 'In Progress'.

2. my_assigned_issues

  • Description: Retrieves all issues that are specifically assigned to you (the authenticated user).
  • Example: "Show me all my high-priority issues" uses this tool to find issues assigned to you that are marked with a high priority.

3. get_issue_detail

  • Description: Fetches the complete details for a single issue using its unique ID or issue number (e.g., "PROJ-123").
  • Example: "Show the detail of issue: XX-1" executes this tool to retrieve all information for issue XX-1.

4. create_issue

  • Description: Creates a new issue in a specified project.
  • Example: "create issue 'Fix login button' in App project" uses this tool to create a new issue.

5. update_issue

  • Description: Modifies the fields of an existing issue, identified by its ID or number.
  • Example: "set XX-1 to Done and assign to Alice" will use this tool with issueId: "XX-1", statusName: "Done", and assigneeName: "Alice".

6. get_issue_options

  • Description: Retrieves the available options for selectable fields (like status, priority, etc.) for a specific issue. This is useful for knowing what values are valid before updating an issue.
  • Example: "show selectable fields for issue XX-1" will list all valid options for fields on issue XX-1.

7. list_issue_comments

  • Description: Lists the comments on a specific issue, with support for pagination.
  • Example: "list comments for XX-1, page 2, 10 per page" runs this command with issueId: "XX-1", pageNumber: 2, and pageSize: 10.

8. create_comment

  • Description: Adds a new comment to an issue. It can also be used to reply to an existing comment.
  • Example: "reply to comment 123 on XX-1: Looks good" uses this tool with issueId: "XX-1", content: "Looks good", and commentId: 123.

9. list_project

  • Description: Shows a list of all projects that the authenticated user has access to.
  • Example: "list projects".

10. list_project_members

  • Description: Lists all members of a specific project.
  • Example: "list members of project 456" executes this tool with projectId: 456.

11. list_org_members

  • Description: Lists all members in the entire organization, with an option to search.
  • Example: "search org members by 'john'" uses this tool with key: "john" to find all members whose names contain "john".

12. current_date

  • Description: Returns the current date in your local timezone.
  • Example: "what's today's date?".