@zeplin/mcp-server 0.2.0 → 1.0.0

package/README.md

@@ -1,8 +1,6 @@
 # Zeplin MCP Server for AI-Assisted UI Implementation
 
-This project implements a Model Context Protocol (MCP) server designed to assist developers in implementing UI screens and components directly from Zeplin designs. By providing Zeplin shortlinks (e.g., `https://zpl.io/...`) in your prompts to AI agents, this server fetches the necessary design specifications and asset details, enabling the models to generate corresponding code for your target framework.
-
-The primary goal is to streamline the developer workflow by bridging the gap between design specifications in Zeplin and actual code implementation.
+This project is a Model Context Protocol server designed to assist developers in implementing UI screens and components directly from Zeplin designs. By providing Zeplin shortlinks (e.g., `https://zpl.io/...`) in your prompts to AI agents, this server fetches the necessary design specifications and asset details, enabling the models to generate corresponding code for your target framework.
 
 ## Table of Contents
 
@@ -29,37 +27,27 @@ The primary goal is to streamline the developer workflow by bridging the gap bet
 *   A Zeplin account.
 *   A Zeplin Personal Access Token (PAT). You can generate one from your Zeplin profile settings under "Developer" > "Personal access tokens". This token will need `read` permissions for the projects/styleguides you want to access.
 
-## Installation
-
-1.  **Clone the repository:**
-    ```bash
-    git clone https://github.com/zeplin/zeplin-mcp.git
-    ```
-
-2.  **Install dependencies:**
-    Using npm:
-    ```bash
-    npm install
-    ```
-
-3.  **Build the project:**
-    The TypeScript code needs to be compiled to JavaScript. Assuming you have a build script in your `package.json` (e.g., `tsc` or `esbuild`):
-    ```bash
-    npm run build
-    ```
-
-    This will typically create a `dist` directory with the compiled JavaScript files (e.g., `dist/index.js`).
-
-## Configuration
+## Usage with MCP Clients (e.g., Cursor)
 
-Create a `.env` file in the root directory of the project with the following content:
+To integrate this server with an MCP client like Cursor, you need to configure the client to connect to this server. Add the following to Cursor's `settings.json` (accessible via `Cmd/Ctrl + Shift + P` -> "Configure Language Specific Settings..." -> "JSON") or a similar configuration file for MCP providers:
 
-```bash
-ZEPLIN_ACCESS_TOKEN=your_zeplin_personal_access_token
+```jsonc
+// In your MCP client's configuration (e.g., Cursor's settings.json)
+{
+  "mcpServers": {
+    "zeplin-mcp": {
+      "command": "npx",
+      "args": [
+        "@zeplin/mcp-server@latest"
+      ],
+      "env": {
+        "ZEPLIN_ACCESS_TOKEN": "<YOUR_ZEPLIN_PERSONAL_ACCESS_TOKEN>" // Replace with your actual token
+      }
+    }
+  }
+}
 ```
 
-Replace `your_zeplin_personal_access_token` with your actual Zeplin Personal Access Token.
-
 ## Development
 
 This project includes several npm scripts to help you with development:
@@ -81,6 +69,14 @@ npm run lint:fix
 npm run inspect
 ```
 
+For debugging purposes if you want to run `npm run inspect` create a `.env` file in the root directory of the project with the following content:
+
+```bash
+ZEPLIN_ACCESS_TOKEN=your_zeplin_personal_access_token
+```
+
+Replace `your_zeplin_personal_access_token` with your actual Zeplin Personal Access Token.
+
 ### Code Style and Linting
 
 This project uses ESLint to enforce code quality and consistency. The configuration is in `eslint.config.js`. Key style guidelines include:
@@ -93,35 +89,6 @@ This project uses ESLint to enforce code quality and consistency. The configurat
 
 When contributing to this project, please ensure your code follows these guidelines by running `npm run lint:fix` before submitting changes.
 
-## Usage with MCP Clients (e.g., Cursor)
-
-To integrate this server with an MCP client like Cursor, you need to configure the client to connect to this server. Add the following to Cursor's `settings.json` (accessible via `Cmd/Ctrl + Shift + P` -> "Configure Language Specific Settings..." -> "JSON") or a similar configuration file for MCP providers:
-
-```jsonc
-// In your MCP client's configuration (e.g., Cursor's settings.json)
-{
-  // ... other configurations
-  "mcpServers": {
-    // ... other providers
-    "zeplin-mcp": {
-      "command": "node",
-      "args": [
-        "/path/to/your/zeplin-mcp/dist/index.js" // IMPORTANT: Update this path
-      ],
-      "env": {
-        "ZEPLIN_ACCESS_TOKEN": "<YOUR_ZEPLIN_PERSONAL_ACCESS_TOKEN>" // IMPORTANT: Replace with your actual token
-      }
-    }
-    // ...
-  }
-  // ...
-}
-```
-
-**Important:**
-*   Replace `"/path/to/your/zeplin-mcp/dist/index.js"` with the **absolute path** to the compiled `index.js` file in your `zeplin-mcp` project directory.
-*   Replace `<YOUR_ZEPLIN_PERSONAL_ACCESS_TOKEN>` with your actual Zeplin PAT.
-
 ## Crafting Effective Prompts
 
 The quality and specificity of your prompts significantly impact the AI's ability to generate accurate and useful code. These are not mandatory but will increase the output quality. Here are some examples to guide you:
@@ -170,8 +137,6 @@ Now, using the components you just implemented (and any other existing component
 * **Builds on previous work:** The AI can use the components it just created.
 * **Clear Zeplin references:** Ensures each piece is based on the correct design.
 
-
-
 ### Strategies to deal with context window limitations
 
 When dealing with complex Zeplin screens or components with many variants and layers, the amount of design data fetched can sometimes be extensive. This can potentially exceed the context window limitations of the AI model you are using, leading to truncated information or less effective code generation. Here are several strategies to manage the amount of information sent to the model:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeplin/mcp-server",
-  "version": "0.2.0",
+  "version": "1.0.0",
   "description": "An MCP server for Zeplin for AI assisted UI development.",
   "author": "Zeplin",
   "license": "MIT",