MCP Server Linearapp

🚀 Linear MCP Server Instructions

This is an MCP (Modular Command Processor) server designed to interact with the Linear platform. It enables users to execute various tasks via the command line or integrated tools, such as creating, updating, and querying issues, managing teams, and projects.

🚀 Quick Start

📦 Installation

Run the following command to install the required packages:

npm install

⚙️ Configuration

Add the API key provided by Linear to the .env file:

LINEAR_API_KEY=your_api_key_here

🏗️ Build the Server

Build the server to start using it:

npm run build

During development, you can use the following command for automatic rebuilds:

npm run watch

💻 Usage Examples

Create a New Issue

To create a new issue, use the linear_create_issue command and specify the necessary parameters. For example:

linear_create_issue --title "New authentication system failure" --description "Report an error on the authentication page."

Update an Existing Issue

To update the attributes (such as priority or status) of an existing issue, use linear_update_issue: For example, set the priority of issue FRONT-123 to "Urgent":

linear_update_issue --issue-id FRONT-123 --priority Urgent

Add a Comment

To add a comment to an issue, use the linear_add_comment command and specify the issue ID and comment content. For example, add the following content to issue LOGIN-456:

linear_add_comment --issue-id LOGIN-456 "The root cause has been identified: the password field is not encrypted correctly."

Search for Issues

Use the linear_search_issues command to search for issues that meet the criteria: For example, find all front - end tasks with the status "In Progress":

linear_search_issues --status "In Progress" --label "Frontend"

Get Project Information

To get detailed information about a specific project, use linear_get_project and specify the project ID. For example, get information about project MOBILE-APP:

linear_get_project --project-id MOBILE-APP

Team Management

Get the Team Member List

To list the members of a team, use linear_get_team_members: For example, get the members of the Frontend team:

linear_get_team_members --team-id frontend-team

Get the Teams a User Belongs to

To view all the teams the current user belongs to, run linear_get_user_teams:

linear_get_user_teams

Tag Management

Create a New Tag

Use the linear_create_tag command to create a new issue tag. For example, create a "backlog" tag:

linear_create_tag --name backlog

Update Tag Attributes

To update the attributes of an existing tag, use linear_update_tag: For example, change the color of the "UI refactor" tag to blue:

linear_update_tag --tag-id ui-refactor --color Blue

Development Instructions

Install Dependencies

Run the following command to install the required packages:

npm install

Configure the API Key

Add the API key provided by Linear to the .env file:

LINEAR_API_KEY=your_api_key_here

Build the Server

Build the server to start using it:

npm run build

During development, you can use the following command for automatic rebuilds:

npm run watch

Examples

Create an Issue and Add a Comment

1. Create an issue using linear_create_issue:

linear_create_issue --title "New authentication system failure" --description "Report an error on the authentication page."

2. Add a comment to the issue using linear_add_comment:

linear_add_comment --issue-id "New authentication system failure" --comment "The root cause has been identified: the password field is not encrypted correctly."

Search and Filter Issues

Use the following command to search for specific types of issues and apply filters:

linear_search_issues --status Resolved --label Frontend

📚 Documentation

Project Structure

• src/: Contains all source code files.
• commands/: Contains defined command modules.
• config/: Contains configuration files and environment variables.
• index.js: The application entry point.

Frequently Asked Questions

How to Get an API Key?

Visit the "User Settings" page on the Linear platform, find the "Developer Tools" section, and you can obtain the API key.

Which Commands are Supported?

The current version supports the following commands:

• linear_create_issue
• linear_update_issue
• linear_add_comment
• linear_search_issues
• linear_get_project
• linear_get_team_members

More commands are under development.

Contribution Guidelines

Community contributions are welcome! Please refer to the CONTRIBUTING.md file in the project repository to learn how to participate in development.

📄 License

This MCP server is released under the MIT License. This means you are free to use, modify, and distribute the software, provided that you comply with the terms and conditions of the MIT License. For more details, please refer to the LICENSE file in the project repository.