Skip to content

Feature: Add Workflow Status Updates #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 35 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
8b3909b
add workflow status updates
steveclarke Mar 27, 2025
150ceb5
update the readme with instructions on running in dev mode
steveclarke Mar 27, 2025
9dbf7d1
feature: add PR info to stories
dlively1 Mar 29, 2025
aec88de
Merge pull request #8 from dlively1/pull-requests
andreasmcdermott Mar 31, 2025
e615dcc
Merge pull request #6 from steveclarke/update-readme
andreasmcdermott Mar 31, 2025
511f5f3
Add PR workflow
andreasmcdermott Mar 31, 2025
51e0ba4
Fix linting.
andreasmcdermott Mar 31, 2025
eb85820
Merge pull request #10 from useshortcut/amcd/ci
andreasmcdermott Mar 31, 2025
1ed0092
Update readme with info regarding issues and troubleshooting.
andreasmcdermott Mar 31, 2025
a03b0d1
Update issue templates
andreasmcdermott Mar 31, 2025
a2c9700
Create config.yml
andreasmcdermott Mar 31, 2025
501602c
Added external_link rendering to getStory
madisonbullard Apr 1, 2025
6dbd480
Add task rendering to getStory tool
madisonbullard Apr 1, 2025
dae53ae
Update src/tools/stories.test.ts
madisonbullard Apr 2, 2025
a95329d
Update src/tools/utils/format.ts
madisonbullard Apr 2, 2025
0ef0ca1
Update src/tools/utils/format.test.ts
andreasmcdermott Apr 2, 2025
1737265
Merge pull request #12 from madisonbullard/tasks
andreasmcdermott Apr 2, 2025
36f064c
Update src/tools/stories.ts
andreasmcdermott Apr 2, 2025
60a3633
Update src/tools/stories.test.ts
andreasmcdermott Apr 2, 2025
4391804
Merge branch 'main' into external_links
andreasmcdermott Apr 2, 2025
a510d8f
Update src/tools/stories.ts
andreasmcdermott Apr 2, 2025
3c9ba58
Merge pull request #11 from madisonbullard/external_links
andreasmcdermott Apr 2, 2025
6f6e1a3
Add list formatting util
andreasmcdermott Apr 2, 2025
0b6da69
v0.2.0
andreasmcdermott Apr 2, 2025
2d20bd6
Merge pull request #13 from useshortcut/amcd/adding-list-formatting-util
andreasmcdermott Apr 2, 2025
01522c1
Add pre-publish script
andreasmcdermott Apr 2, 2025
16dc7e0
Merge pull request #14 from useshortcut/amcd/fix-pre-publish
andreasmcdermott Apr 2, 2025
ae57dad
Add claude code mcp instructions.
andreasmcdermott Apr 2, 2025
b4cb485
Merge pull request #15 from useshortcut/amcd/claude-code
andreasmcdermott Apr 2, 2025
c5e8ec2
Improve iteration stats.
andreasmcdermott Apr 4, 2025
722ae51
Improve stats.
andreasmcdermott Apr 4, 2025
892eeba
Merge pull request #18 from useshortcut/amcd/issue-17/improve-iterati…
andreasmcdermott Apr 4, 2025
9152668
add workflow status updates
steveclarke Mar 27, 2025
71991e7
Merge branch 'feature/workflow-status' of github.com:steveclarke/mcp-…
steveclarke Apr 7, 2025
98742fb
Fix formatting
steveclarke Apr 8, 2025
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
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Issues
about: Issues template
title: ''
labels: ''
assignees: ''

---

**Describe your issue**
A clear and concise description of what the issue is and what error messages you are seeing.

**MCP Config**
Please share your MCP config (but make sure to not include your Shortcut API token)

**Environment (please complete the following information):**
- OS: [e.g. Windows, Mac, Linux]
- IDE: [e.g. Cursor, Windsurf]
- IDE Version [e.g. 1.5.9]
- Node version [e.g. v22.14.0]
- Node version manager [e.g. Nvm, Asdf, Mise]

**Additional context**
Add any other context about the problem here.
49 changes: 49 additions & 0 deletions .github/workflows/pr_actions.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: PR Checks
env:
HUSKY: 0

on:
workflow_dispatch:
pull_request:

jobs:
pr-checks:
strategy:
fail-fast: true

permissions:
contents: read

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
- uses: biomejs/setup-biome@v2
with:
version: latest

- name: Install dependencies
working-directory: ./
run: |
npm ci

- name: Run linter
working-directory: ./
run: |
biome ci .

- name: Run type checker
working-directory: ./
run: |
npm run ts

- name: Run tests
working-directory: ./
run: |
npm run test

- name: Build
working-directory: ./
run: |
npm run build
2 changes: 1 addition & 1 deletion .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
npm run format
git add .
git add -u .
85 changes: 82 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,16 +51,95 @@ See the [official Cursor docs](https://docs.cursor.com/context/model-context-pro
}
```

### Claude Code

See the [official Claude Code docs](https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/tutorials#set-up-model-context-protocol-mcp) for more information.

_You can add a new MCP server from the Claude Code CLI. But modifying the json file directly is simpler!_

1. Open the Claude Code configuration file (it should be in `~/.claude.json`).
2. Find the `projects` > `mcpServers` section and add the following details and save the file:

```json
{
"projects": {
"mcpServers": {
"shortcut": {
"command": "npx",
"args": [
"-y",
"@shortcut/mcp"
],
"env": {
"SHORTCUT_API_TOKEN": "<YOUR_SHORTCUT_API_TOKEN>"
}
}
}
}
}
```

## Issues and Troubleshooting

Before doing anything else, please make sure you are running the latest version!

If you run into problems using this MCP server, you have a couple of options:

- Open an issue on [GitHub](https://github.com/useshortcut/mcp-server-shortcut/issues)
- Ask for help in the community [Slack](https://shortcut.com/join-slack)

You can also check the list of [common issues](#common-issues) below to see if there is a known solution already.

### Common Issues and Solutions

#### NPX command not working when using MISE for version management

If you are using MISE for managing Node and NPM versions, you may encounter a "Client closed" error when trying to run the MCP server. Installing this extension into your IDE might help: https://github.com/hverlin/mise-vscode/.

## Development

## Installation
### Installation

```bash
npm install
```

## Build
### Build

```bash
npm run build
```
```

### Running the Development Server Locally

To test your local development version of the MCP server rather than using the published package, follow these steps:

1. Build the project:
```bash
npm run build
```

2. Create or modify your `mcp.json` file to reference your local build:
```json
{
"mcpServers": {
"shortcut": {
"command": "node",
"args": [
"/path/to/your/local/mcp-server-shortcut/dist/index.js"
],
"env": {
"SHORTCUT_API_TOKEN": "<YOUR_SHORTCUT_API_TOKEN>"
}
}
}
}
```

3. Place this `mcp.json` file in one of the following locations:
- For Cursor: In your home directory (`~/.cursor/mcp.json`) or in your project directory (`.cursor/mcp.json`)
- For Windsurf: Use the MCP Configuration Panel to add the custom server

4. Restart your AI assistant (Cursor or Windsurf) to load the new configuration.

This allows you to instantly test changes to the MCP server without having to publish a new version.
2 changes: 1 addition & 1 deletion biome.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
},
"files": {
"ignoreUnknown": false,
"ignore": ["node_modules/**"]
"include": ["src/**", "index.ts"]
},
"formatter": {
"enabled": true,
Expand Down
Loading