chore: update example (#17)

jiachengxu · web-flow · commit a3fb32567c00 · 2025-04-23T11:05:20.000+08:00
* update example

* fix url

* add keywords
diff --git a/.cursor/mcp.json b/.cursor/mcp.json
@@ -3,13 +3,13 @@
     "argocd-mcp": {
       "command": "npx",
       "args": [
-        "argocd-mcp",
+        "argocd-mcp@latest",
         "stdio"
       ],
       "env": {
         "NODE_TLS_REJECT_UNAUTHORIZED": "0",
-        "ARGOCD_BASE_URL": "https://your-argocd-server.com",
-        "ARGOCD_API_TOKEN": "your_argocd_token"
+        "ARGOCD_BASE_URL": "<argocd_url>",
+        "ARGOCD_API_TOKEN": "<argocd_token>"
       }
     }
   }
diff --git a/.vscode/mcp.json b/.vscode/mcp.json
@@ -1,25 +1,11 @@
 {
-  "inputs": [
-    {
-      "id": "argocd-base-url",
-      "type": "promptString",
-      "description": "Enter the ArgoCD base URL",
-      "password": false
-    },
-    {
-      "id": "argocd-api-token",
-      "type": "promptString",
-      "description": "Enter the ArgoCD API token",
-      "password": true
-    }
-  ],
   "servers": {
     "argocd-mcp-sse": {
       "type": "sse",
       "url": "http://localhost:3000/sse",
       "headers": {
-        "x-argocd-base-url": "${input:argocd-base-url}",
-        "x-argocd-api-token": "${input:argocd-api-token}"
+        "x-argocd-base-url": "<argocd_url>",
+        "x-argocd-api-token": "<argocd_token>"
       }
     }
   }
diff --git a/README.md b/README.md
@@ -8,31 +8,17 @@ const config = JSON.stringify({
   "name": "argocd-mcp",
   "command": "npx",
   "args": ["argocd-mcp@latest", "stdio"],
-  "inputs": [
-    {
-      "id": "argocd-base-url",
-      "type": "promptString",
-      "description": "Enter the ArgoCD base URL",
-      "password": false
-    },
-    {
-      "id": "argocd-api-token",
-      "type": "promptString",
-      "description": "Enter the ArgoCD API token",
-      "password": true
-    }
-  ],
   "env": {
-    "ARGOCD_BASE_URL": "${input:argocd-base-url}",
-    "ARGOCD_API_TOKEN": "${input:argocd-api-token}"
+    "ARGOCD_BASE_URL": "<argocd_url>",
+    "ARGOCD_API_TOKEN": "<argocd_token>"
   }
 });
 const urlForWebsites = `vscode:mcp/install?${encodeURIComponent(config)}`;
 // Github markdown does not allow linking to `vscode:` directly, so you can use our redirect:
 const urlForGithub = `https://insiders.vscode.dev/redirect?url=${encodeURIComponent(urlForWebsites)}`;
 -->
 
-[<img src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Server&color=0098FF" alt="Install in VS Code">](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522argocd-mcp%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522argocd-mcp%2540latest%2522%252C%2522stdio%2522%255D%252C%2522inputs%2522%253A%255B%257B%2522id%2522%253A%2522argocd-base-url%2522%252C%2522type%2522%253A%2522promptString%2522%252C%2522description%2522%253A%2522Enter%2520the%2520ArgoCD%2520base%2520URL%2522%252C%2522password%2522%253Afalse%257D%252C%257B%2522id%2522%253A%2522argocd-api-token%2522%252C%2522type%2522%253A%2522promptString%2522%252C%2522description%2522%253A%2522Enter%2520the%2520ArgoCD%2520API%2520token%2522%252C%2522password%2522%253Atrue%257D%255D%252C%2522env%2522%253A%257B%2522ARGOCD_BASE_URL%2522%253A%2522%2524%257Binput%253Aargocd-base-url%257D%2522%252C%2522ARGOCD_API_TOKEN%2522%253A%2522%2524%257Binput%253Aargocd-api-token%257D%2522%257D%257D)  [<img alt="Install in VS Code Insiders" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=flat-square&label=Install%20Server&color=24bfa5">](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522argocd-mcp%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522argocd-mcp%2540latest%2522%252C%2522stdio%2522%255D%252C%2522inputs%2522%253A%255B%257B%2522id%2522%253A%2522argocd-base-url%2522%252C%2522type%2522%253A%2522promptString%2522%252C%2522description%2522%253A%2522Enter%2520the%2520ArgoCD%2520base%2520URL%2522%252C%2522password%2522%253Afalse%257D%252C%257B%2522id%2522%253A%2522argocd-api-token%2522%252C%2522type%2522%253A%2522promptString%2522%252C%2522description%2522%253A%2522Enter%2520the%2520ArgoCD%2520API%2520token%2522%252C%2522password%2522%253Atrue%257D%255D%252C%2522env%2522%253A%257B%2522ARGOCD_BASE_URL%2522%253A%2522%2524%257Binput%253Aargocd-base-url%257D%2522%252C%2522ARGOCD_API_TOKEN%2522%253A%2522%2524%257Binput%253Aargocd-api-token%257D%2522%257D%257D)
+[<img src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Server&color=0098FF" alt="Install in VS Code">](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522argocd-mcp%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522argocd-mcp%2540latest%2522%252C%2522stdio%2522%255D%252C%2522env%2522%253A%257B%2522ARGOCD_BASE_URL%2522%253A%2522%253Cargocd_url%253E%2522%252C%2522ARGOCD_API_TOKEN%2522%253A%2522%253Cargocd_token%253E%2522%257D%257D)  [<img alt="Install in VS Code Insiders" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=flat-square&label=Install%20Server&color=24bfa5">](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522argocd-mcp%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522argocd-mcp%2540latest%2522%252C%2522stdio%2522%255D%252C%2522env%2522%253A%257B%2522ARGOCD_BASE_URL%2522%253A%2522%253Cargocd_url%253E%2522%252C%2522ARGOCD_API_TOKEN%2522%253A%2522%253Cargocd_token%253E%2522%257D%257D)
 
 
 
@@ -58,12 +44,12 @@ const urlForGithub = `https://insiders.vscode.dev/redirect?url=${encodeURICompon
     "argocd-mcp": {
       "command": "npx",
       "args": [
-        "argocd-mcp",
+        "argocd-mcp@latest",
         "stdio"
       ],
       "env": {
-        "ARGOCD_BASE_URL": "https://your-argocd-server.com",
-        "ARGOCD_API_TOKEN": "your_argocd_token"
+        "ARGOCD_BASE_URL": "<argocd_url>",
+        "ARGOCD_API_TOKEN": "<argocd_token>"
       }
     }
   }
@@ -77,31 +63,17 @@ const urlForGithub = `https://insiders.vscode.dev/redirect?url=${encodeURICompon
 1. Follow the [Use MCP servers in VS Code documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers), and create a `.vscode/mcp.json` file in your project:
 ```json
 {
-  "inputs": [
-    {
-      "id": "argocd-base-url",
-      "type": "promptString",
-      "description": "Enter the ArgoCD base URL",
-      "password": false
-    },
-    {
-      "id": "argocd-api-token",
-      "type": "promptString",
-      "description": "Enter the ArgoCD API token",
-      "password": true
-    }
-  ],
   "servers": {
     "argocd-mcp-stdio": {
       "type": "stdio",
       "command": "npx",
       "args": [
-        "argocd-mcp",
+        "argocd-mcp@latest",
         "stdio"
       ],
       "env": {
-        "ARGOCD_BASE_URL": "${input:argocd-base-url}",
-        "ARGOCD_API_TOKEN": "${input:argocd-api-token}"
+        "ARGOCD_BASE_URL": "<argocd_url>",
+        "ARGOCD_API_TOKEN": "<argocd_token>"
       }
     }
   }
@@ -119,12 +91,12 @@ const urlForGithub = `https://insiders.vscode.dev/redirect?url=${encodeURICompon
     "argocd-mcp": {
       "command": "npx",
       "args": [
-        "argocd-mcp",
+        "argocd-mcp@latest",
         "stdio"
       ],
       "env": {
-        "ARGOCD_BASE_URL": "https://your-argocd-server.com",
-        "ARGOCD_API_TOKEN": "your_argocd_token"
+        "ARGOCD_BASE_URL": "<argocd_url>",
+        "ARGOCD_API_TOKEN": "<argocd_token>"
       }
     }
   }
diff --git a/package.json b/package.json
@@ -1,15 +1,34 @@
 {
   "name": "argocd-mcp",
   "version": "0.0.0",
-  "description": "ArgoCD MCP Server",
+  "description": "Argo CD MCP Server",
+  "keywords": [
+    "mcp",
+    "argocd",
+    "argocd-mcp",
+    "argocd-mcp-server",
+    "argo-cd",
+    "argo-cd-mcp",
+    "argo-cd-mcp-server",
+    "cicd",
+    "cicd-mcp",
+    "cicd-mcp-server",
+    "gitops",
+    "gitops-mcp",
+    "gitops-mcp-server",
+    "kubernetes",
+    "kubernetes-mcp",
+    "kubernetes-mcp-server"
+  ],
   "main": "dist/index.js",
   "type": "module",
   "bin": {
     "argocd-mcp": "dist/index.js"
   },
   "files": [
     "dist",
-    "README.md"
+    "README.md",
+    "LICENSE"
   ],
   "scripts": {
     "dev": "tsx watch src/index.ts sse",
@@ -19,7 +38,6 @@
     "build:watch": "tsup --watch",
     "prepare": "npm run build"
   },
-  "keywords": [],
   "author": "Akuity, Inc.",
   "license": "Apache-2.0",
   "dependencies": {

Original file line number	Diff line number	Diff line change
`@@ -3,13 +3,13 @@`
`3`	`3`	`"argocd-mcp": {`
`4`	`4`	`"command": "npx",`
`5`	`5`	`"args": [`
`6`		`- "argocd-mcp",`
	`6`	`+ "argocd-mcp@latest",`
`7`	`7`	`"stdio"`
`8`	`8`	`],`
`9`	`9`	`"env": {`
`10`	`10`	`"NODE_TLS_REJECT_UNAUTHORIZED": "0",`
`11`		`- "ARGOCD_BASE_URL": "https://your-argocd-server.com",`
`12`		`- "ARGOCD_API_TOKEN": "your_argocd_token"`
	`11`	`+ "ARGOCD_BASE_URL": "<argocd_url>",`
	`12`	`+ "ARGOCD_API_TOKEN": "<argocd_token>"`
`13`	`13`	`}`
`14`	`14`	`}`
`15`	`15`	`}`