feat: add linting, formatting, and CI workflow

Author: sapientpants

.github/workflows/ci.yml

@@ -0,0 +1,80 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    name: Test Coverage
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v3
+        with:
+          version: 10.7.0
+          
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+        
+      - name: Run tests with coverage
+        run: pnpm run test:coverage
+        
+      - name: Upload coverage reports
+        uses: codecov/codecov-action@v4
+        
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v3
+        with:
+          version: 10.7.0
+          
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+        
+      - name: Run ESLint
+        run: pnpm run lint
+        
+      - name: Type Check
+        run: pnpm run check-types
+
+  format:
+    name: Format
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v3
+        with:
+          version: 10.7.0
+          
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+        
+      - name: Check formatting
+        run: pnpm run format:check 

.husky/pre-commit

@@ -0,0 +1,11 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+# Run lint-staged to check formatting and linting on staged files
+npx lint-staged || exit 1
+
+# Run type checking
+pnpm run check-types || exit 1
+
+# Run tests
+pnpm run test || exit 1 

.prettierignore

@@ -0,0 +1,6 @@
+dist/
+node_modules/
+coverage/
+pnpm-lock.yaml
+package-lock.json
+*.d.ts 

.prettierrc

@@ -0,0 +1,9 @@
+{
+  "semi": true,
+  "trailingComma": "es5",
+  "singleQuote": true,
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "endOfLine": "lf"
+} 

README.md

@@ -1,11 +1,12 @@
 # DeepSource MCP Server
 
-A TypeScript-based server implementation for DeepSource MCP (Mission Control Panel).
+A Model Context Protocol server implementation for DeepSource integration. This server allows AI models to interact with DeepSource's API to list projects and retrieve issues.
 
 ## Prerequisites
 
 - Node.js (v16 or higher recommended)
 - pnpm (v10.7.0 or higher)
+- DeepSource API Key
 
 ## Installation
 
@@ -20,6 +21,11 @@ cd deepsource-mcp-server
 pnpm install
 ```
 
+3. Set up your environment variables:
+```bash
+export DEEPSOURCE_API_KEY=your_api_key_here
+```
+
 ## Development
 
 To start the development server with hot-reload:
@@ -52,24 +58,59 @@ To run the compiled version:
 pnpm run start
 ```
 
-## Project Structure
+## Server Endpoints
+
+The server exposes two HTTP endpoints:
 
+- `GET /sse` - Server-Sent Events endpoint for MCP clients to connect
+- `POST /messages` - Endpoint for MCP clients to send messages
+
+## Available Tools
+
+### list-projects
+
+Lists all DeepSource projects accessible with your API key.
+
+Example usage:
+```typescript
+const result = await client.callTool({
+  name: "list-projects",
+  arguments: {}
+});
 ```
-deepsource-mcp-server/
-├── src/              # Source files
-├── dist/             # Compiled files (generated)
-├── node_modules/     # Dependencies
-├── package.json      # Project configuration
-├── tsconfig.json     # TypeScript configuration
-└── README.md         # This file
+
+### get-project-issues
+
+Retrieves all issues for a specific DeepSource project.
+
+Example usage:
+```typescript
+const result = await client.callTool({
+  name: "get-project-issues",
+  arguments: {
+    projectKey: "your-project-key"
+  }
+});
 ```
 
-## Scripts
+## Available Prompts
 
-- `pnpm run dev` - Run the TypeScript code directly using ts-node
-- `pnpm run build` - Compile TypeScript to JavaScript
-- `pnpm run start` - Run the compiled JavaScript
-- `pnpm run watch` - Watch for changes and recompile automatically
+- `list-projects` - Prompt for listing all projects
+- `get-project-issues` - Prompt for getting issues from a specific project
+
+## Project Structure
+
+```
+deepsource-mcp-server/
+├── src/
+│   ├── index.ts        # Main server implementation
+│   └── deepsource.ts   # DeepSource API client
+├── dist/               # Compiled files (generated)
+├── node_modules/       # Dependencies
+├── package.json        # Project configuration
+├── tsconfig.json       # TypeScript configuration
+└── README.md          # This file
+```
 
 ## License
 

eslint.config.js

@@ -0,0 +1,55 @@
+import js from '@eslint/js';
+import * as tseslint from '@typescript-eslint/eslint-plugin';
+import tsparser from '@typescript-eslint/parser';
+import prettier from 'eslint-plugin-prettier';
+
+export default [
+  {
+    ignores: ['dist/**', 'node_modules/**', 'coverage/**', 'jest.config.js']
+  },
+  js.configs.recommended,
+  {
+    files: ['**/*.ts'],
+    languageOptions: {
+      parser: tsparser,
+      parserOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+      },
+      globals: {
+        process: 'readonly',
+        console: 'readonly',
+        module: 'readonly',
+        require: 'readonly',
+      },
+    },
+    plugins: {
+      '@typescript-eslint': tseslint,
+      prettier: prettier,
+    },
+    rules: {
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      '@typescript-eslint/no-explicit-any': 'warn',
+      '@typescript-eslint/no-unused-vars': 'error',
+      'prettier/prettier': 'error',
+    },
+  },
+  {
+    files: ['**/*.test.ts'],
+    languageOptions: {
+      globals: {
+        describe: 'readonly',
+        it: 'readonly',
+        expect: 'readonly',
+        beforeEach: 'readonly',
+        beforeAll: 'readonly',
+        afterEach: 'readonly',
+        afterAll: 'readonly',
+        jest: 'readonly',
+      },
+    },
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+    },
+  },
+]; 

jest.config.js

@@ -0,0 +1,18 @@
+/** @type {import('jest').Config} */
+export default {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testMatch: ['**/__tests__/**/*.test.ts'],
+  collectCoverageFrom: ['src/**/*.ts', '!src/**/*.test.ts'],
+  coverageDirectory: 'coverage',
+  coverageReporters: ['text', 'lcov'],
+  transform: {
+    '^.+\\.ts$': ['ts-jest', {
+      useESM: true,
+    }],
+  },
+  extensionsToTreatAsEsm: ['.ts'],
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
+}; 

package.json

@@ -2,21 +2,63 @@
   "name": "deepsource-mcp-server",
   "version": "1.0.0",
   "description": "DeepSource MCP Server",
+  "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc",
     "start": "node dist/index.js",
     "dev": "ts-node src/index.ts",
     "watch": "tsc -w",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "format:check": "prettier --check \"src/**/*.ts\"",
+    "check-types": "tsc --noEmit",
+    "prepare": "husky",
+    "validate": "npm run check-types && npm run lint && npm run test"
   },
-  "keywords": [],
+  "lint-staged": {
+    "*.{ts,tsx}": [
+      "prettier --check",
+      "eslint"
+    ]
+  },
+  "keywords": [
+    "deepsource",
+    "mcp",
+    "model-context-protocol"
+  ],
   "author": "",
   "license": "ISC",
   "packageManager": "pnpm@10.7.0",
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.8.0",
+    "axios": "^1.6.8",
+    "express": "^4.19.1",
+    "zod": "^3.22.4"
+  },
   "devDependencies": {
+    "@eslint/js": "^9.23.0",
+    "@types/express": "^4.17.21",
+    "@types/jest": "^29.5.12",
     "@types/node": "^22.13.14",
+    "@types/supertest": "^6.0.2",
+    "@typescript-eslint/eslint-plugin": "^8.28.0",
+    "@typescript-eslint/parser": "^8.28.0",
+    "eslint": "^9.23.0",
+    "eslint-config-prettier": "^10.1.1",
+    "eslint-plugin-prettier": "^5.2.5",
+    "husky": "^9.1.7",
+    "jest": "^29.7.0",
+    "lint-staged": "^15.5.0",
+    "nock": "^13.5.4",
+    "prettier": "^3.5.3",
+    "supertest": "^6.3.4",
+    "ts-jest": "^29.1.2",
     "ts-node": "^10.9.2",
     "typescript": "^5.8.2"
   }