@fridaplatform-stk/figma2frida-mcp 1.0.0 → 1.0.2

package/README.md

@@ -19,11 +19,18 @@ This MCP server connects Figma Desktop MCP to your design system components stor
 
 - Node.js 18+ 
 - Figma Desktop with MCP enabled (running at `http://127.0.0.1:3845/sse`)
-- Pinecone account with API key
-- Frida AI account with bearer token
+- API token for authentication
 
 ## Installation
 
+### From npm (Recommended)
+
+```bash
+npm install -g @fridaplatform-stk/figma2frida-mcp
+```
+
+### From Source
+
 ```bash
 # Clone the repository
 git clone <your-repo-url>
@@ -40,25 +47,17 @@ npm run build
 
 ### Environment Variables
 
-Create a `.env` file in the project root with the following variables:
+**Note**: Most configuration is built into the package. The following are passed as command-line arguments:
+- `--pinecone-namespace`: Your namespace identifier (required)
+- `--frida-api-token`: Your API token for authentication (required)
 
+Optional environment variables for local development:
 ```bash
-# Pinecone Configuration
-PINECONE_API_KEY=your_pinecone_api_key_here
-PINECONE_INDEX_NAME=your_index_name
-# PINECONE_NAMESPACE is passed as argument (not in .env)
-
-# Frida AI Configuration
-FRIDA_BEARER_TOKEN=your_frida_bearer_token_here
-FRIDA_BASE_URL=https://api.frida.ai
-
 # Server Configuration (optional)
 HTTP_STREAM=true  # Set to true for HTTP mode, false for stdio
 PORT=8080         # Port for HTTP stream mode
 ```
 
-**Important**: `PINECONE_NAMESPACE` should NOT be in `.env` - it's passed as a command-line argument.
-
 ## Local Development
 
 ### Running Locally
@@ -79,9 +78,10 @@ chmod +x run-local.sh
 The script will:
 - Start the server in HTTP Stream mode
 - Use the namespace from the command-line argument
-- Load all other settings from `.env` file
 - Make the server available at `http://localhost:8080/mcp`
 
+**Note**: For local development, you may need to pass the `--frida-api-token` argument as well.
+
 ### Testing the Server
 
 Once running, test with curl:
@@ -106,7 +106,28 @@ Add this to your MCP configuration file (location depends on your IDE):
       "args": [
         "/absolute/path/to/figma2frida_mcp/dist/figma2frida.js",
         "--pinecone-namespace",
-        "org01_proj01"
+        "org01_proj01",
+        "--frida-api-token",
+        "your_api_token_here"
+      ]
+    }
+  }
+}
+```
+
+**Or using npm package:**
+
+```json
+{
+  "mcpServers": {
+    "figma2frida": {
+      "command": "npx",
+      "args": [
+        "@fridaplatform-stk/figma2frida-mcp",
+        "--pinecone-namespace",
+        "org01_proj01",
+        "--frida-api-token",
+        "your_api_token_here"
       ]
     }
   }
@@ -114,10 +135,11 @@ Add this to your MCP configuration file (location depends on your IDE):
 ```
 
 **Important**:
-- Use the **absolute path** to `dist/figma2frida.js`
+- Use the **absolute path** to `dist/figma2frida.js` if installing from source
 - Replace `org01_proj01` with your namespace
-- Make sure you've run `npm run build` first
-- The `.env` file should be in the project root
+- Replace `your_api_token_here` with your API token
+- Both `--pinecone-namespace` and `--frida-api-token` are required arguments
+- Make sure you've run `npm run build` first if installing from source
 
 ### Restart Your IDE
 
@@ -130,34 +152,6 @@ After adding the configuration, restart Visual Studio / GitHub Copilot to load t
 - `figma_suggest_components` - Suggest design system components based on Figma design (with Pinecone & Frida AI)
 - `figma_improve_layout` - Trigger layout improvement to match Figma frame reference
 
-## Project Structure
-
-```
-figma2frida_mcp/
-├── src/
-│   └── figma2frida/
-│       ├── figma2frida.ts          # Main MCP server
-│       ├── clients/
-│       │   └── figma-client.ts     # Figma Desktop MCP client
-│       ├── handlers/
-│       │   └── component-suggestion-handler.ts
-│       ├── services/
-│       │   ├── component-lookup.ts
-│       │   ├── frida/
-│       │   │   └── frida-client.ts
-│       │   └── pinecone/
-│       │       └── pinecone-service.ts
-│       └── utils/
-│           ├── component-extractor.ts
-│           ├── design-query-extractor.ts
-│           └── formatters.ts
-├── dist/
-│   ├── figma2frida.js              # Built server (for production)
-│   └── figma2frida.d.ts
-├── run-local.sh                     # Local development script
-├── .env                             # Environment variables (create this)
-└── package.json
-```
 
 ## Development
 
@@ -175,19 +169,63 @@ npm run dev
 
 ## Publishing to npm
 
+### ⚠️ Permission Required
+
+**Important:** This package is published under the `@fridaplatform-stk` scope and requires **permission from Fridaplatform** to publish or update.
+
+- You must be a member of the `@fridaplatform-stk` npm organization
+- You must have publish permissions for the organization
+- Contact the Fridaplatform team to request access if needed
+
+### First-Time Publishing
+
+```bash
+# 1. Login to npm
+npm login
+
+# 2. Verify you're logged in
+npm whoami
+
+# 3. Verify organization access
+npm access ls-packages @fridaplatform-stk
+
+# 4. Build the package
+npm run build
+
+# 5. Verify what will be published
+npm pack --dry-run
+
+# 6. Publish (requires permission)
+npm publish
+```
+
+### Updating/Republishing
+
+To update the package with a new version:
+
 ```bash
-# Build first
+# 1. Update version in package.json (or use npm version)
+npm version patch   # for bug fixes (1.0.0 -> 1.0.1)
+npm version minor   # for new features (1.0.0 -> 1.1.0)
+npm version major   # for breaking changes (1.0.0 -> 2.0.0)
+
+# 2. Build the package
 npm run build
 
-# Publish
+# 3. Verify changes
+npm pack --dry-run
+
+# 4. Publish the update (requires permission)
 npm publish
 ```
 
+### Installation
+
 After publishing, users can install globally:
 
 ```bash
 npm install -g @fridaplatform-stk/figma2frida-mcp
-figma2frida-mcp --pinecone-namespace org01_proj01
+figma2frida-mcp --pinecone-namespace org01_proj01 --frida-api-token your_api_token_here
 ```
 
 ## Troubleshooting
@@ -198,8 +236,8 @@ Run `npm install` to install dependencies.
 ### "Figma MCP connection failed"
 Make sure Figma Desktop is running with MCP enabled at `http://127.0.0.1:3845/sse`.
 
-### "Pinecone namespace not found"
-Make sure you're passing `--pinecone-namespace` as an argument (not in `.env`).
+### "Missing required argument"
+Make sure you're passing both `--pinecone-namespace` and `--frida-api-token` as arguments.
 
 ### Visual Studio can't find the MCP server
 - Check the absolute path is correct