Init MCP (#1)

* feat: init

* feat: add readme

* feat: use commander to parse argv

* refactor: use package.json information

* Refacto

* Add CI config

---------

Co-authored-by: BruceWouaigne <denis@linkup.so>

Author: RaphaelEscrig

.github/workflows/_run-tests.yaml

@@ -0,0 +1,24 @@
+name: Run Tests
+
+on:
+  workflow_call:
+
+jobs:
+  run-tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: ["18.x", "19.x", "20.x"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install
+        run: npm install
+      - name: Build
+        run: npm run build
+      - name: Lint
+        run: npm run lint
+      - name: Test
+        run: npm run test

.github/workflows/pr.yaml

@@ -0,0 +1,14 @@
+name: PR targeting Main
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches: main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  run-tests:
+    uses: ./.github/workflows/_run-tests.yaml

.github/workflows/push-main.yml

@@ -0,0 +1,9 @@
+name: Push on Main
+
+on:
+  push:
+    branches: main
+
+jobs:
+  run-tests:
+    uses: ./.github/workflows/_run-tests.yaml

.github/workflows/release.yml

@@ -0,0 +1,25 @@
+name: Publish to npm
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  run-tests:
+    uses: ./.github/workflows/_run-tests.yaml
+
+  build-and-publish:
+    needs: run-tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm run build
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -7,6 +7,9 @@ yarn-error.log*
 lerna-debug.log*
 .pnpm-debug.log*
 
+# Distribution / packaging
+build/
+
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 

.prettierrc

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

README.md

@@ -0,0 +1,89 @@
+# Linkup Model Context Protocol
+
+This package provides a [Model Context Protocol](https://modelcontextprotocol.com/) server for integrating Linkup's web search functionality with AI models that support function calling through MCP.
+
+## Installation & Usage
+
+You can run the Linkup MCP server directly using npx:
+
+```bash
+npx -y linkup-mcp --api-key=YOUR_LINKUP_API_KEY
+```
+
+Alternatively, you can set your API key as an environment variable:
+
+```bash
+export LINKUP_API_KEY=YOUR_LINKUP_API_KEY
+npx -y linkup-mcp
+```
+
+# Command Line Options
+
+| Option       | Description                                                       |
+| ------------ | ----------------------------------------------------------------- |
+| `--api-key`  | Your Linkup API key (required unless `LINKUP_API_KEY` env is set) |
+| `--base-url` | Custom API base URL (default: `https://api.linkup.so/v1`)         |
+| `--help, -h` | Show help text                                                    |
+
+# Usage with Claude
+
+Add the following to your `claude_desktop_config.json`. See the [MCP documentation](https://modelcontextprotocol.io/quickstart/user) for more details.
+
+To ensure compatibility with Claude, we recommend that `npx` command be accessible within the same environment. A common location for this is `/usr/local/bin/node` (on mac)
+
+```json
+{
+  "mcpServers": {
+    "linkup": {
+      "command": "npx",
+      "args": ["-y", "linkup-mcp"],
+      "env": {
+        "LINKUP_API_KEY": "YOUR_LINKUP_API_KEY"
+      }
+    }
+  }
+}
+```
+
+or
+
+```json
+{
+  "mcpServers": {
+    "linkup": {
+      "command": "npx",
+      "args": ["-y", "linkup-mcp", "--api-key=YOUR_LINKUP_API_KEY"]
+    }
+  }
+}
+```
+
+## Available Tools
+
+| Tool         | Description                             |
+| ------------ | --------------------------------------- |
+| `search-web` | Perform a web search query using Linkup |
+
+## Development
+
+Clone the repository and install dependencies:
+
+```bash
+git clone git@github.com:LinkupPlatform/linkup-js-mcp.git
+cd linkup-js-mcp
+npm install
+```
+
+# Available Scripts
+
+| Script               | Description                  |
+| -------------------- | ---------------------------- |
+| `npm run build`      | Build the TypeScript project |
+| `npm run lint`       | Run ESLint                   |
+| `npm run format`     | Format code with Prettier    |
+| `npm run test`       | Run tests                    |
+| `npm run test:watch` | Run tests in watch mode      |
+
+# License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

eslint.config.mjs

@@ -0,0 +1,39 @@
+import js from '@eslint/js';
+import typescript from '@typescript-eslint/eslint-plugin';
+import tsParser from '@typescript-eslint/parser';
+import prettier from 'eslint-plugin-prettier';
+import eslintConfigPrettier from 'eslint-config-prettier';
+import globals from 'globals';
+
+export default [
+  js.configs.recommended,
+  {
+    files: ['**/*.ts'],
+    languageOptions: {
+      parser: tsParser,
+      ecmaVersion: 2022,
+      sourceType: 'module',
+      globals: {
+        ...globals.node,
+        ...globals.jest,
+      },
+    },
+    plugins: {
+      '@typescript-eslint': typescript,
+      prettier: prettier,
+    },
+    rules: {
+      ...typescript.configs.recommended.rules,
+      ...eslintConfigPrettier.rules,
+      'prettier/prettier': [
+        'error',
+        {
+          useTabs: false,
+          tabWidth: 2,
+        },
+      ],
+      'no-tabs': 'error',
+      indent: ['error', 2, { SwitchCase: 1 }],
+    },
+  },
+];

jest.config.ts

@@ -0,0 +1,12 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testMatch: ['**/__tests__/**/*.ts'],
+  moduleFileExtensions: ['ts', 'js', 'json', 'node'],
+  collectCoverage: true,
+  coverageDirectory: 'coverage',
+  coverageReporters: ['text', 'lcov'],
+  transform: {
+    '^.+\\.ts$': ['ts-jest', { tsconfig: 'tsconfig.json' }],
+  },
+};