Esa

🚀 esa MCP Server

This is an MCP (Middleware Component Protocol) server for interacting with Esa. It allows you to integrate with Esa's features via the command line or other tools, such as creating, updating, and deleting projects, comments, and managing team members.

🚀 Quick Start

✨ Features

Project-related

1. esa_list_projects - Retrieve all projects in the team. Input Parameters:

   • page (number, optional): The page number to retrieve.
   • per_page (number, optional): The number of results per page (maximum 100).

2. esa_get_project - Get detailed information about a specific project. Input Parameters:

   • project_id (string, required): The ID of the project to retrieve.
   • include (string, optional): Specify the associated data to include (e.g., "members", "comments").

3. esa_create_project - Create a new project. Input Parameters:

   • name (string, required): The name of the project.
   • description (string, optional): The description of the project.
   • public (boolean, optional): Whether the project is public, default is false.

4. esa_update_project - Update the information of an existing project. Input Parameters:

   • project_id (string, required): The ID of the project to update.
   • name (string, optional): The new name of the project.
   • description (string, optional): The new description of the project.
   • public (boolean, optional): The flag indicating whether the project is public.

5. esa_delete_project - Delete a specific project. Input Parameters:

   • project_id (string, required): The ID of the project to delete.

Comment-related

1. esa_list_comments - Get all comments in a project. Input Parameters:

   • project_id (number, required): The ID of the project to retrieve comments from.
   • page (number, optional): The page number.
   • per_page (number, optional): The number of results per page (maximum 100).

2. esa_get_comment - Get detailed information about a specific comment. Input Parameters:

   • comment_id (string, required): The ID of the comment to retrieve.
   • include (string, optional): Specify the associated data to include (e.g., "project", "author").

3. esa_create_comment - Create a new project comment. Input Parameters:

   • project_id (number, required): The ID of the project to comment on.
   • body (string, required): The content of the comment (supports Markdown format).
   • author (string, optional): The screen name of the comment author.

Team Member-related

1. esa_get_members - Get all members in the team. Input Parameters:

   • page (number, optional): The page number.
   • per_page (number, optional): The number of results per page (maximum 100).

2. esa_get_member - Get detailed information about a specific team member. Input Parameters:

   • screen_name_or_email (string, required): The screen name or email address of the member to retrieve.

📦 Installation

Environment Requirements

• Operating System: An operating system that supports the POSIX.1-2008 standard (e.g., Linux, macOS, etc.)
• Software Versions:
  • Node.js: v8 or higher
  • npm: 5.6.0 or higher

Installation Steps

1. Clone the repository:

git clone https://github.com/yourusername/esa-mcp.git
cd esa-mcp

2. Install dependencies:

npm install

3. Configure environment variables:
   • Create or modify the .env file:

     ESA_TOKEN=your_token_here
     ESA_TEAM_ID=your_team_id_here
     

4. Start the server:

npm start

💻 Usage Examples

Basic Usage

# Create a public project named "My New Project"
curl --location 'http://localhost:3000/api/projects' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "My New Project",
    "description": "A new project for our team.",
    "public": true
}'

Advanced Usage

# Update the name and description of project with ID 123
curl --location 'http://localhost:3000/api/projects/123' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Updated Project Name",
    "description": "This is an updated description."
}'

# Get all comments of project with ID 456
curl --location 'http://localhost:3000/api/projects/456/comments' \
--header 'Content-Type: application/json'

📚 Documentation

Error Handling

Status Code Explanation

• 200 OK - The request was successful.
• 401 Unauthorized - Unauthorized or the token is invalid.
• 404 Not Found - The resource does not exist.
• 500 Internal Server Error - An internal server error occurred.

Common Error Scenarios

1. Authentication Failure

   # Returns status code 401 and the following content:
   {
     "error": "Unauthorized",
     "message": "Invalid token provided."
   }
   

2. Resource Not Found

   # Returns status code 404 and the following content:
   {
     "error": "Not Found",
     "message": "Project with ID 123 not found."
   }
   

Help and Support

• Documentation: esa-mcp Documentation
• Support: Contact support@yourdomain.com