Skip to content
This repository was archived by the owner on Aug 21, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ updates:
versioning-strategy: "auto"
labels:
- "dependencies"
- "pnpm"
- "yarn"
commit-message:
prefix: "chore"
include: "scope"
23 changes: 9 additions & 14 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,29 +11,24 @@ jobs:
- name: Checkout
uses: actions/checkout@v4

- name: Setup PNPM
uses: pnpm/action-setup@v4
with:
version: 8.15.4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: "18.19.0"
cache: "pnpm"
cache-dependency-path: "pnpm-lock.yaml"
node-version: "20.19.0"
cache: "yarn"
cache-dependency-path: "yarn.lock"

- name: Verify lockfile
run: |
if [ ! -f "pnpm-lock.yaml" ]; then
echo "pnpm-lock.yaml not found!"
if [ ! -f "yarn.lock" ]; then
echo "yarn.lock not found!"
exit 1
fi
echo "pnpm-lock.yaml found"
cat pnpm-lock.yaml
echo "yarn.lock found"
head -20 yarn.lock

- name: Install dependencies
run: pnpm install
run: yarn install

- name: Run ESLint
run: pnpm lint
run: yarn lint
5 changes: 2 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
node_modules
build/

# Package manager lock files (we use pnpm)
# Package manager lock files (we use yarn)
package-lock.json
yarn.lock
pnpm-lock.yaml

# Environment variables
.env
Expand All @@ -28,4 +28,3 @@ coverage/
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
2 changes: 1 addition & 1 deletion .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ docs/
coverage/

# Lock files
pnpm-lock.yaml
yarn.lock
31 changes: 20 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@ If you want to use this as a git submodule in your project:

```bash
# From your project root (e.g., pie-mono)
git submodule add https://github.com/stashgg/mcp-linear tools/mcp-linear
git submodule update --init --recursive
# Note: The first command is only necessary if the submodule is not yet setup in the repo
git submodule add https://github.com/stashgg/mcp-linear path/to/mcp-linear
git submodule update --init --recursive # initializes submodule in your local setup
```

2. **Run the setup script:**
Expand Down Expand Up @@ -61,7 +62,7 @@ If you've cloned this repository directly:
### Final Configuration Steps

2. **Follow the script's instructions:**
- It will install dependencies with pnpm and build the package
- It will install dependencies with yarn and build the package
- It will install the MCP tool globally with npm (more reliable for global tools)
- It will help you set up your Linear API key and MCP config

Expand Down Expand Up @@ -101,17 +102,17 @@ If you've cloned this repository directly:

### Prerequisites

- Node.js (v16 or higher)
- Node.js (v20 or higher)
- npm (for global installation)
- pnpm (for local development)
- yarn (for local development)

### Installation

1. **Install dependencies and build:**

```bash
pnpm install
pnpm build
yarn install
yarn build
```

2. **Install the package globally with npm:**
Expand Down Expand Up @@ -161,21 +162,21 @@ All tickets created through the MCP automatically get an `agent-created` label f
### Local Development Setup:

```bash
pnpm install
pnpm build
yarn install
yarn build
```

### Testing Changes:

```bash
pnpm build
yarn build
npm install -g . # Reinstall globally
# Restart Cursor to pick up changes
```

### Package Management:

- **Local development**: Uses `pnpm` for faster installs and better dependency management
- **Local development**: Uses `yarn` for faster installs and better dependency management
- **Global installation**: Uses `npm` for better compatibility with global tools and MCP

## Troubleshooting
Expand All @@ -186,6 +187,14 @@ npm install -g . # Reinstall globally
Make sure your npm global bin directory is in your PATH (`npm bin -g`)
- **API key issues:**
Make sure you've set `LINEAR_API_KEY` in your environment
- **Node version incompatibility:**
This project requires Node.js 20 or higher. If you're using nvm:
```bash
nvm use 20
# or install if not available
nvm install 20
nvm use 20
```
- **Submodule issues:**
Run `git submodule update --init --recursive` to ensure submodules are properly initialized
- **Tools not showing up in Cursor:**
Expand Down
Loading