ci: add github action to create releases

Author: kombucha

.github/workflows/create-release.yml

@@ -0,0 +1,22 @@
+name: Create Release
+on:
+  push:
+    tags:
+      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
+jobs:
+  build:
+    runs-on: macos-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install Dependencies
+        run: npm install
+      - name: Build for Mac
+        run: npm run build -- --target=bun-darwin-arm64 --minify --sourcemap --outfile dist/algolia-mcp-darwin-arm64-${{ github.ref_name }}
+      - name: Zip Release
+        run: zip -r dist/algolia-mcp-darwin-arm64-${{ github.ref_name }}.zip dist/algolia-mcp-darwin-arm64-${{ github.ref_name }}
+      - name: Release
+        uses: softprops/action-gh-release@v2
+        with:
+          make_latest: "true"
+          files: dist/*

README.md

@@ -1,55 +1,79 @@
 # Algolia NodeJS MCP implementation
 
-## Getting Started
+- [Running the MCP Server (Mac Only)](#running-the-mcp-server-mac-only)
+- [What can I ask for?](#what-can-i-ask-for)
+  - [Account](#account)
+  - [Apps](#apps)
+  - [Search](#search)
+  - [AB Testing](#ab-testing)
+  - [Analytics](#analytics)
+  - [Monitoring](#monitoring)
+- [CLI options](#cli-options)
+  - [List available commands](#list-available-commands)
+  - [Server options](#server-options)
+- [Setup dev environment](#setup-dev-environment)
 
-### Installation
+## Running the MCP Server (Mac Only)
 
-You need at least Node 22
+1. Download the latest version of the Algolia MCP server at https://github.com/algolia/mcp-node/releases
 
-```sh
-git clone https://github.com/algolia/mcp-node
-cd mcp-node
-npm i
-```
+2. Extract the Zip file
 
-### Claude MCP configuration
+3. From a terminal, run `xattr -r -d com.apple.quarantine <path_to_executable>`
+
+> [!IMPORTANT]
+> Why do you need to run this command?
+> This executable is not signed because I don't have a payed Apple Developer Account.
+> This means that MacOs will "quarantine" it by default when it is downloaded from the internet.
+> The command remove the quarantine, allowing you to run the program. If you don't trust the build,
+> you can always build it yourself from source with `npm run build` (see development environment setup below) 😄.
+
+4. Configure Claude Desktop
 
 ```json
 {
   "mcpServers": {
     "algolia-mcp": {
-      "command": "<PATH_TO_BIN>/node",
+      "command": "<path_to_executable>",
       "args": [
-        "--experimental-strip-types",
-        "--no-warnings=ExperimentalWarning",
-        "<PATH_TO_PROJECT>/src/app.ts"
+        // See CLI options below
       ]
     }
   }
 }
 ```
 
-### Advanced
+## What can I ask for?
 
-If you want to restrict or allow more operationIds, you can pass more options (see CLI usage below)
+Algolia Node MCP lets you interact with your Algolia apps and indices. Here are some example prompts to get you started:
 
-```json
-{
-  "mcpServers": {
-    "algolia-mcp": {
-      "command": "<PATH_TO_BIN>/node",
-      "args": [
-        "--experimental-strip-types",
-        "--no-warnings=ExperimentalWarning",
-        "<PATH_TO_PROJECT>/src/app.ts",
-        "-t getSettings"
-      ]
-    }
-  }
-}
-```
+### Account
+
+- "What is the email address associated to my account?"
+
+### Apps
+
+- "List all my apps Algolia apps."
+- "List all the apps that I own."
+- "What's the ID for app Latency?"
+
+### Search
+
+- "Search all items in the products index of app Latency where brand = 'Nike' and price < 100."
+
+### AB Testing
+
+- "Do I have any AB Tests currently running on application <APPLICATION_ID>?"
+
+### Analytics
+
+- "I have an index named <index_name> on application <application_id>, can you generate a graph for no results rate in DE region over the past month? Please use react and recharts."
 
-## CLI
+### Monitoring
+
+- "Are there any incidents going on at Algolia currently?"
+
+## CLI options
 
 ### List available commands
 
@@ -80,32 +104,32 @@ Options:
   -h, --help                 display help for command
 ```
 
-## What can I ask for?
-
-Algolia Node MCP lets you interact with your Algolia apps and indices. Here are some example prompts to get you started:
-
-### Account
-
-- "What is the email address associated to my account?"
-
-### Apps
-
-- "List all my apps Algolia apps."
-- "List all the apps that I own."
-- "What's the ID for app Latency?"
-
-### Search
-
-- "Search all items in the products index of app Latency where brand = 'Nike' and price < 100."
+## Setup dev environment
 
-### AB Testing
-
-- "Do I have any AB Tests currently running on application <APPLICATION_ID>?"
+You need at least Node 22
 
-### Analytics
+```sh
+git clone https://github.com/algolia/mcp-node
+cd mcp-node
+npm i
+```
 
-- "I have an index named <index_name> on application <application_id>, can you generate a graph for no results rate in DE region over the past month? Please use react and recharts."
+And then you'll need to configure Claude Desktop like so:
 
-### Monitoring
+```json
+{
+  "mcpServers": {
+    "algolia-mcp": {
+      "command": "<PATH_TO_BIN>/node",
+      "args": [
+        "--experimental-strip-types",
+        "--no-warnings=ExperimentalWarning",
+        "<PATH_TO_PROJECT>/src/app.ts"
+      ]
+    }
+  }
+}
+```
 
-- "Are there any incidents going on at Algolia currently?"
+> [!TIP]
+> You'll need to restart Claude Desktop every time you make a modification.

package.json

@@ -6,7 +6,7 @@
     "start": "node --experimental-strip-types --no-warnings=ExperimentalWarnings src/app.ts",
     "type-check": "tsc --noEmit",
     "lint": "eslint --ext .ts src",
-    "build": "bun build ./src/app.ts --compile --minify --sourcemap --target=bun-darwin-arm64 --outfile dist/algolia-mcp-darwin-arm64"
+    "build": "bun build ./src/app.ts --compile"
   },
   "type": "module",
   "keywords": [],