hevy-mcp 1.3.1 → 1.4.0

package/README.md

@@ -65,9 +65,9 @@ Make sure to replace `your-api-key-here` with your actual Hevy API key.
 
 ## Configuration
 
-Create a `.env` file in the project root with the following content:
+Create a `.env` file in the project root (you can copy from [.env.sample](.env.sample)) with the following content:
 
-```
+```env
 HEVY_API_KEY=your_hevy_api_key_here
 ```
 
@@ -92,7 +92,7 @@ npm start
 
 ## Available MCP Tools
 
-The server implements the following MCP tools:
+The server implements the following MCP tools for interacting with the Hevy API:
 
 ### Workout Tools
 - `get-workouts`: Fetch and format workout data
@@ -119,7 +119,7 @@ The server implements the following MCP tools:
 
 ## Project Structure
 
-```
+```plaintext
 hevy-mcp/
 ├── .env                   # Environment variables (API keys)
 ├── src/
@@ -136,9 +136,11 @@ hevy-mcp/
 │       └── validators.ts  # Input validation helpers
 ├── scripts/               # Build and utility scripts
 └── tests/                 # Test suite
+    ├── integration/       # Integration tests with real API
+    │   └── hevy-mcp.integration.test.ts  # MCP server integration tests
 ```
 
-## Development
+## Development Guide
 
 ### Code Style
 
@@ -148,9 +150,62 @@ This project uses Biome for code formatting and linting:
 npm run check
 ```
 
+### Testing
+
+#### Run All Tests
+
+To run all tests (unit and integration), use:
+
+```bash
+npm test
+```
+
+> **Note:** If the `HEVY_API_KEY` environment variable is set, integration tests will also run. If not, only unit tests will run.
+
+#### Run Only Unit Tests
+
+To run only unit tests (excluding integration tests):
+
+```bash
+npx vitest run --exclude tests/integration/**
+```
+
+Or with coverage:
+
+```bash
+npx vitest run --coverage --exclude tests/integration/**
+```
+
+#### Run Only Integration Tests
+
+To run only the integration tests (requires a valid `HEVY_API_KEY`):
+
+```bash
+npx 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.
+
+##### GitHub Actions Configuration
+
+For GitHub Actions:
+
+1. Unit tests will always run on every push and pull request
+2. Integration tests will only run if the `HEVY_API_KEY` secret is set in the repository settings
+
+To set up the `HEVY_API_KEY` secret:
+
+1. Go to your GitHub repository
+2. Click on "Settings" > "Secrets and variables" > "Actions"
+3. Click on "New repository secret"
+4. Set the name to `HEVY_API_KEY` and the value to your Hevy API key
+5. Click "Add secret"
+
+If the secret is not set, the integration tests step will be skipped with a message indicating that the API key is missing.
+
 ### Generating API Client
 
-The API client is generated from the OpenAPI specification using Kiota:
+The API client is generated from the OpenAPI specification using [Kiota](https://github.com/microsoft/kiota):
 
 ```bash
 npm run export-specs
@@ -159,11 +214,11 @@ npm run build:client
 
 ## License
 
-This project is licensed under the MIT License - see the LICENSE file for details.
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
 ## Contributing
 
-Contributions are welcome! Please feel free to submit a Pull Request.
+Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
 
 ## Acknowledgements
 

package/dist/index.js

@@ -652,7 +652,9 @@ function registerWorkoutTools(server2, hevyClient2) {
       });
       const workouts = data?.workouts?.map((workout) => formatWorkout(workout)) || [];
       if (workouts.length === 0) {
-        return createEmptyResponse("No workouts found for the specified parameters");
+        return createEmptyResponse(
+          "No workouts found for the specified parameters"
+        );
       }
       return createJsonResponse(workouts);
     }, "get-workouts")
@@ -700,7 +702,9 @@ function registerWorkoutTools(server2, hevyClient2) {
       });
       const events = data?.events || [];
       if (events.length === 0) {
-        return createEmptyResponse(`No workout events found for the specified parameters since ${since}`);
+        return createEmptyResponse(
+          `No workout events found for the specified parameters since ${since}`
+        );
       }
       return createJsonResponse(events);
     }, "get-workout-events")
@@ -767,7 +771,9 @@ function registerWorkoutTools(server2, hevyClient2) {
         };
         const data = await hevyClient2.v1.workouts.post(requestBody);
         if (!data) {
-          return createEmptyResponse("Failed to create workout: Server returned no data");
+          return createEmptyResponse(
+            "Failed to create workout: Server returned no data"
+          );
         }
         const workout = formatWorkout(data);
         return createJsonResponse(workout, {
@@ -2088,7 +2094,7 @@ function createClient(apiKey2, baseUrl) {
 
 // package.json
 var name = "hevy-mcp";
-var version = "1.4.0";
+var version = "1.3.1";
 
 // src/index.ts
 var HEVY_API_BASEURL = "https://api.hevyapp.com";