Cpropster Linear MCP Server

🚀 Linear MCP Server

The Linear MCP Server is a tool designed to interact with the Linear API. It offers multiple functional modules for retrieving teams, statuses, priorities, labels, milestones, projects, cycles, as well as creating and updating issues.

✨ Features

• Get Teams: List all teams.
• Get Statuses: List all statuses of a specific team.
• Get Priorities: List all priorities of a specific team.
• Get Labels: List all labels of a specific team.
• Get Milestones (Time Tracking): List all milestones of a specific team.
• Get Projects: List projects of a specific team. Optionally, specify the team ID and the number of results to return.
• Get Cycles: List cycles of a specific team. The team ID is required.
• Create Issue: Create a new issue. The team ID, title, and other optional parameters such as assignee ID and state ID are required.
• Update Issue: Modify the information of an existing issue. The issue ID and other optional parameters are required.

🚀 Quick Start

📦 Installation

Install dependencies using npm or yarn:

npm install linear-sdk @types/node --save-dev

Or

yarn add linear-sdk @types/node -D

🛠️ Initialization

Create a src/index.ts file and add the following code:

import { Linear } from '@linear/sdk';

const linear = new Linear({
  token: 'your_linear_token',
});

async function main() {
  try {
    const teams = await linear.teams.list();
    console.log('Teams:', teams);
    
    // Optional: Perform other operations, such as creating an issue
    const issue = await linear.issues.create({
      teamId: 'team_id', 
      title: 'Test Issue',
      description: 'This is a test issue.',
      assigneeId: 'assignee_id', // Optional
      stateId: 'state_id', // Optional
      priority: 0, // Optional, range is 0-4
    });
    console.log('Created Issue:', issue);
  } catch (error) {
    console.error('Error:', error);
  }
}

main();

▶️ Run

Compile and run with TypeScript:

npm run build && npm start

📚 Documentation

Create a Linear Application

1. Log in to Linear.
2. Navigate to Settings > Applications and click "Create New Application".
3. Fill in the application name and description, and select the required permissions (minimum permissions are recommended).

Get a Token

On the application details page, find and copy the API token. Add this token to the .env file:

LINEAR_TOKEN=your_token_here

⚠️ Security Notes

• Avoid Committing Sensitive Information: Ensure that the .env file is not included in the version control system.
• Use Environment Variables: Access the token through environment variables in the code, for example, process.env.LINEAR_TOKEN.

💻 Usage Examples

Basic Usage

Get All Teams

const teams = await linear.teams.list();

Create an Issue

const issue = await linear.issues.create({
  teamId: 'team_id',
  title: 'New Issue',
  description: 'This is a test issue.',
  assigneeId: 'assignee_id', // Optional
});

Tutorial

• Get Team List: Call the teams.list() method.
• Create an Issue: Use the issues.create() method and pass the necessary parameters.

❓ Frequently Asked Questions

Q: How to handle errors?

A: Use a try-catch statement to catch exceptions and output error information to the console:

try {
  // Operation code
} catch (error) {
  console.error('An error occurred:', error);
}

Q: Does it support multiple teams?

A: Yes, specify the specific team for the operation through the teamId parameter.

🤝 Contribution Guide

Welcome to submit issues and pull requests to the GitHub repository: linear-mcp

📄 License

This project is licensed under the MIT License.