hevy-mcp 1.10.16 → 1.12.3

package/README.md

@@ -1,7 +1,7 @@
 # hevy-mcp: Model Context Protocol Server for Hevy Fitness API
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 [![smithery badge](https://smithery.ai/badge/@chrisdoc/hevy-mcp)](https://smithery.ai/server/@chrisdoc/hevy-mcp)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
 A Model Context Protocol (MCP) server implementation that interfaces with the [Hevy fitness tracking app](https://www.hevyapp.com/) and its [API](https://api.hevyapp.com/docs/). This server enables AI assistants to access and manage workout data, routines, exercise templates, and more through the Hevy API (requires PRO subscription).
 
@@ -13,20 +13,22 @@ A Model Context Protocol (MCP) server implementation that interfaces with the [H
 - **Folder Organization**: Manage routine folders
 - **Webhook Subscriptions**: Create, view, and delete webhook subscriptions for workout events
 
+> **Note:** HTTP transport and Docker images remain deprecated. Smithery deployment now uses the official TypeScript runtime flow (no Docker required), or you can run the server locally via stdio (e.g., `npx hevy-mcp`). Existing GHCR images remain available but are no longer updated.
+
 ## Prerequisites
 
 - Node.js (v20 or higher)
-- npm or yarn
+- pnpm (via Corepack)
 - A Hevy API key
 
 ## Installation
 
-### Installing via Smithery
+### Run via npx (recommended)
 
-To install hevy-mcp for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@chrisdoc/hevy-mcp):
+You can launch the server directly without cloning:
 
 ```bash
-npx -y @smithery/cli install @chrisdoc/hevy-mcp --client claude
+HEVY_API_KEY=your_hevy_api_key_here npx -y hevy-mcp
 ```
 
 ### Manual Installation
@@ -36,9 +38,7 @@ git clone https://github.com/chrisdoc/hevy-mcp.git
 cd hevy-mcp
 
 # Install dependencies
-npm install
-
-# Create .env file from sample
+corepack use pnpm@10.22.0
 cp .env.sample .env
 # Edit .env and add your Hevy API key
 ```
@@ -67,7 +67,7 @@ Make sure to replace `your-api-key-here` with your actual Hevy API key.
 You can supply your Hevy API key in two ways:
 
 1. Environment variable (`HEVY_API_KEY`)
-2. Command-line argument (`--hevy-api-key=your_key` or `hevy-api-key=your_key` after `--` when using npm scripts)
+2. Command-line argument (`--hevy-api-key=your_key` or `hevy-api-key=your_key` after `--` when using pnpm scripts)
 
 Create a `.env` file in the project root (you can copy from [.env.sample](.env.sample)) with the following content if using the environment variable approach:
 
@@ -78,81 +78,40 @@ HEVY_API_KEY=your_hevy_api_key_here
 Replace `your_hevy_api_key_here` with your actual Hevy API key. If you prefer the command argument approach you can skip setting the environment variable and start the server with for example:
 
 ```bash
-npm start -- --hevy-api-key=your_hevy_api_key_here
-```
-
-Or in HTTP mode:
-
-```bash
-npm start -- --http --hevy-api-key=your_hevy_api_key_here
+pnpm start -- --hevy-api-key=your_hevy_api_key_here
 ```
 
-## Transport Modes
+## Transport
 
-The MCP server supports two transport modes:
+### Deploy via Smithery (TypeScript runtime)
 
-### Stdio Transport (Default)
+Smithery can bundle and host `hevy-mcp` without Docker by importing the exported `createServer` and `configSchema` from `src/index.ts`.
 
-The default mode uses stdio transport, which is suitable for integration with MCP clients like Claude Desktop and Cursor:
+1. Ensure dependencies are installed: `pnpm install`
+2. Launch the Smithery playground locally:
 
-```bash
-npm start
-# or
-node dist/index.js
-```
+   ```bash
+   pnpm run smithery:dev
+   ```
 
-### HTTP Transport
+   The CLI will prompt for `HEVY_API_KEY`, invoke `createServer({ config })`, and open the Smithery MCP playground.
 
-The server can also run in HTTP mode for remote access or web-based integrations:
+3. Build the deployable bundle:
 
-```bash
-# Start in HTTP mode (env var)
-npm start -- --http
-# Start in HTTP mode (CLI arg)
-npm start -- --http --hevy-api-key=your_hevy_api_key_here
-# Or using node directly
-node dist/index.js --http --hevy-api-key=your_hevy_api_key_here
-
-# Using environment variable
-MCP_TRANSPORT=http npm start
-```
-
-#### HTTP Configuration
-
-The HTTP transport can be configured using environment variables:
-
-```env
-# Transport mode
-MCP_TRANSPORT=http
-
-# HTTP server configuration
-MCP_HTTP_HOST=127.0.0.1
-PORT=3000
-
-# DNS rebinding protection (recommended for production)
-MCP_DNS_REBINDING_PROTECTION=true
-MCP_ALLOWED_HOSTS=127.0.0.1,localhost
-```
+   ```bash
+   pnpm run smithery:build
+   ```
 
-#### HTTP Endpoints
+4. Connect the repository to Smithery and trigger a deployment from their dashboard. Configuration is handled entirely through the exported Zod schema, so no additional `smithery.yaml` env mapping is required.
 
-When running in HTTP mode, the following endpoints are available:
-
-- `POST /mcp` - MCP client-to-server communication
-- `GET /mcp` - Server-to-client notifications (SSE)
-- `DELETE /mcp` - Session termination
-- `GET /health` - Health check endpoint
-
-#### Session Management
-
-The HTTP transport includes session management for stateful connections. Each client session is identified by a unique session ID that must be included in the `mcp-session-id` header for subsequent requests.
+hevy-mcp now runs exclusively over stdio, which works seamlessly with MCP-aware clients like Claude Desktop and Cursor. HTTP transport has been removed to simplify deployment.
 
 ## Usage
 
 ### Development
 
 ```bash
-npm run dev
+pnpm run dev
 ```
 
 This starts the MCP server in development mode with hot reloading.
@@ -160,76 +119,13 @@ This starts the MCP server in development mode with hot reloading.
 ### Production
 
 ```bash
-npm run build
-npm start
-```
-
-### Docker
-
-The project includes a Dockerfile for containerized deployments. Docker images are automatically built and pushed to GitHub Container Registry (GHCR) during the CI/CD process.
-
-#### Using Pre-built Images
-
-Pull and run the latest image:
-
-```bash
-docker run -d \
-  --name hevy-mcp \
-  -e HEVY_API_KEY=your_api_key_here \
-  -p 3000:3000 \
-  ghcr.io/chrisdoc/hevy-mcp:latest
-
-# Or using CLI argument for the key (omit env var)
-docker run -d \
-  --name hevy-mcp \
-  -p 3000:3000 \
-  ghcr.io/chrisdoc/hevy-mcp:latest \
-  hevy-api-key=your_api_key_here
+pnpm run build
+pnpm start
 ```
 
-#### Building Locally
+### Docker (deprecated)
 
-```bash
-# Build the image
-docker build -t hevy-mcp .
-
-# Run the container
-docker run -d \
-  --name hevy-mcp \
-  -e HEVY_API_KEY=your_api_key_here \
-  -p 3000:3000 \
-  hevy-mcp
-
-# Or with CLI argument
-docker run -d \
-  --name hevy-mcp \
-  -p 3000:3000 \
-  hevy-mcp \
-  hevy-api-key=your_api_key_here
-```
-
-#### Docker Compose Example
-
-```yaml
-version: '3.8'
-services:
-  hevy-mcp:
-    image: ghcr.io/chrisdoc/hevy-mcp:latest
-    environment:
-      - HEVY_API_KEY=your_api_key_here
-      - MCP_TRANSPORT=http
-      - MCP_HTTP_HOST=0.0.0.0
-      - PORT=3000
-    ports:
-      - "3000:3000"
-    restart: unless-stopped
-```
-
-#### Available Image Tags
-
-- `latest` - Latest stable release
-- `main` - Latest development build from main branch  
-- `v1.8.8`, `v1.8`, `v1` - Semantic version tags for releases
+Docker-based workflows have been retired so we can focus on the stdio-native experience. The bundled `Dockerfile` now exits with a clear message to prevent accidental builds, and `.dockerignore` simply documents the deprecation. Previously published images remain available on GHCR (for example `ghcr.io/chrisdoc/hevy-mcp:latest`), but they are **no longer updated**. For the best experience, run the server locally via `npx hevy-mcp` or your own Node.js runtime.
 
 ## Available MCP Tools
 
@@ -298,7 +194,7 @@ hevy-mcp/
 This project uses Biome for code formatting and linting:
 
 ```bash
-npm run check
+pnpm run check
 ```
 
 ### Testing
@@ -308,7 +204,7 @@ npm run check
 To run all tests (unit and integration), use:
 
 ```bash
-npm test
+pnpm test
 ```
 
 > **Note:** If the `HEVY_API_KEY` environment variable is set, integration tests will also run. If not, only unit tests will run.
@@ -318,13 +214,13 @@ npm test
 To run only unit tests (excluding integration tests):
 
 ```bash
-npx vitest run --exclude tests/integration/**
+pnpm vitest run --exclude tests/integration/**
 ```
 
 Or with coverage:
 
 ```bash
-npx vitest run --coverage --exclude tests/integration/**
+pnpm vitest run --coverage --exclude tests/integration/**
 ```
 
 #### Run Only Integration Tests
@@ -332,7 +228,7 @@ npx vitest run --coverage --exclude tests/integration/**
 To run only the integration tests (requires a valid `HEVY_API_KEY`):
 
 ```bash
-npx vitest run tests/integration
+pnpm vitest run tests/integration
 ```
 
 **Note:** The integration tests will fail if the `HEVY_API_KEY` environment variable is not set. This is by design to ensure that the tests are always run with a valid API key.
@@ -359,12 +255,16 @@ If the secret is not set, the integration tests step will be skipped with a mess
 The API client is generated from the OpenAPI specification using [Kubb](https://kubb.dev/):
 
 ```bash
-npm run export-specs
-npm run build:client
+pnpm run export-specs
+pnpm run build:client
 ```
 
 Kubb generates TypeScript types, API clients, Zod schemas, and mock data from the OpenAPI specification.
 
+### Troubleshooting
+
+- **Rollup optional dependency missing**: If you see an error similar to `Cannot find module @rollup/rollup-linux-x64-gnu`, set the environment variable `ROLLUP_SKIP_NODEJS_NATIVE_BUILD=true` before running `pnpm run build`. This forces Rollup to use the pure JavaScript fallback and avoids the npm optional dependency bug on some Linux runners.
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
@@ -376,4 +276,4 @@ Contributions are welcome! Please feel free to submit a Pull Request. For major
 ## Acknowledgements
 
 - [Model Context Protocol](https://github.com/modelcontextprotocol) for the MCP SDK
-- [Hevy](https://www.hevyapp.com/) for their fitness tracking platform and API
+- [Hevy](https://www.hevyapp.com/) for their fitness tracking platform and API

package/dist/index.d.ts

@@ -1 +1,45 @@
-#!/usr/bin/env node
+import * as _modelcontextprotocol_sdk_server from '@modelcontextprotocol/sdk/server';
+import { z } from 'zod';
+
+declare const serverConfigSchema: z.ZodObject<{
+    apiKey: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    apiKey: string;
+}, {
+    apiKey: string;
+}>;
+declare const configSchema: z.ZodObject<{
+    apiKey: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    apiKey: string;
+}, {
+    apiKey: string;
+}>;
+type ServerConfig = z.infer<typeof serverConfigSchema>;
+declare function createServer({ config }: {
+    config: ServerConfig;
+}): _modelcontextprotocol_sdk_server.Server<{
+    method: string;
+    params?: {
+        [x: string]: unknown;
+        _meta?: {
+            [x: string]: unknown;
+            progressToken?: string | number | undefined;
+        } | undefined;
+    } | undefined;
+}, {
+    method: string;
+    params?: {
+        [x: string]: unknown;
+        _meta?: {
+            [x: string]: unknown;
+        } | undefined;
+    } | undefined;
+}, {
+    [x: string]: unknown;
+    _meta?: {
+        [x: string]: unknown;
+    } | undefined;
+}>;
+
+export { configSchema, createServer as default };