@globalpayments/vega-mcp-stdio-server 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +20 -40
  2. package/package.json +1 -1
  3. package/LICENSE +0 -7
  4. package/index.js +0 -62901
package/README.md CHANGED
@@ -1,20 +1,14 @@
1
1
  # @globalpayments/vega-mcp-stdio-server
2
2
 
3
- Vega MCP server package for stdio transport.
3
+ MCP stdio server package for Vega documentation tools.
4
4
 
5
- ## Installation
5
+ ## Install
6
6
 
7
7
  ```bash
8
- npm install @globalpayments/vega-mcp-stdio-server
8
+ npm install -D @globalpayments/vega-mcp-stdio-server
9
9
  ```
10
10
 
11
- Pre-installation is optional. The recommended setup is to run via `npx` directly in MCP client config.
12
-
13
- ## Usage
14
-
15
- Use this package as an MCP stdio server in tools like VS Code, Cursor, or Claude Desktop.
16
-
17
- Example MCP server configuration:
11
+ ## VS Code MCP Configuration
18
12
 
19
13
  ```json
20
14
  {
@@ -28,7 +22,13 @@ Example MCP server configuration:
28
22
  }
29
23
  ```
30
24
 
31
- To pin a specific package version, use:
25
+ ## Optional Startup Arguments
26
+
27
+ - `--refresh-cache`: Force refresh of local documentation cache.
28
+ - `--refresh-mode=once`: Refresh knowledge base once per conversation (default).
29
+ - `--refresh-mode=always`: Refresh once at the start of each user message.
30
+
31
+ Example:
32
32
 
33
33
  ```json
34
34
  {
@@ -36,38 +36,18 @@ To pin a specific package version, use:
36
36
  "vega": {
37
37
  "type": "stdio",
38
38
  "command": "npx",
39
- "args": ["-y", "@globalpayments/vega-mcp-stdio-server@0.1.0"]
39
+ "args": [
40
+ "-y",
41
+ "@globalpayments/vega-mcp-stdio-server",
42
+ "--refresh-cache",
43
+ "--refresh-mode=always"
44
+ ]
40
45
  }
41
46
  }
42
47
  }
43
48
  ```
44
49
 
45
- ## Optional Environment Variables
46
-
47
- - `VEGA_MCP_BLOB_URL`: Azure Blob base URL for docs content.
48
- - `VEGA_MCP_BLOB_SAS`: SAS token for private blob access.
49
- - `VEGA_MCP_CACHE_DIR`: local cache directory.
50
- - `VEGA_MCP_CACHE_TTL`: cache TTL in hours.
51
-
52
- ## Optional Startup Flags
53
-
54
- - `--refresh-cache`: force refresh of cached content for requested version.
55
- - `--refresh-mode=once|always`: control refresh guidance behavior.
56
- - `once` (default): refresh once per conversation/session, then reuse the loaded knowledge base unless the user explicitly says the Vega version changed.
57
- - `always`: refresh once at the start of each new user message before the first Vega tool call, using the latest version detected from package.json.
58
-
59
- ## Available MCP Tools
60
-
61
- - `list_components`
62
- - `get_component_api`
63
- - `get_component_examples`
64
- - `list_types`
65
- - `get_type_definition`
66
- - `search_docs`
67
- - `get_doc`
68
- - `refresh_knowledge_base`
69
-
70
- ## Node Requirement
50
+ ## Notes
71
51
 
72
- - Node.js >= 20
73
- - Npm >= 10
52
+ - Vega version is detected from the project `package.json`.
53
+ - Supported package scopes: `@globalpayments/*` and `@heartlandone/*`.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@globalpayments/vega-mcp-stdio-server",
3
- "version": "0.1.0",
3
+ "version": "0.2.0",
4
4
  "type": "module",
5
5
  "license": "UNLICENSED",
6
6
  "repository": {
package/LICENSE DELETED
@@ -1,7 +0,0 @@
1
- Copyright (c) Heartland Payment Systems, LLC.
2
-
3
- All rights reserved.
4
-
5
- This software and associated documentation files are proprietary and confidential.
6
- Unauthorized copying, modification, distribution, sublicensing, or use of this software,
7
- in whole or in part, is strictly prohibited without prior written permission from the copyright holder.