tenable-mcp-docs 1.0.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.
- package/README.md +169 -0
- package/bin/tenable-mcp-docs +46 -0
- package/package.json +22 -0
package/README.md
ADDED
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
# Tenable Docs MCP Server (npx Package)
|
|
2
|
+
|
|
3
|
+
Run the Tenable Docs MCP server directly with `npx` - no installation required!
|
|
4
|
+
|
|
5
|
+
## What is this?
|
|
6
|
+
|
|
7
|
+
This is an **npx launcher** for the [tenable-docs-mcp](https://github.com/CatFoxVoyager/tenable-mcp-docs) server. It downloads the latest version from GitHub and runs it immediately.
|
|
8
|
+
|
|
9
|
+
## Quick Start
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
# Run immediately with npx
|
|
13
|
+
npx tenable-mcp-docs
|
|
14
|
+
|
|
15
|
+
# Or with debug output
|
|
16
|
+
DEBUG=1 npx tenable-mcp-docs
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
That's it! No npm install, no git clone, just run and go.
|
|
20
|
+
|
|
21
|
+
## What is npx?
|
|
22
|
+
|
|
23
|
+
**npx** is a package runner that:
|
|
24
|
+
- Downloads packages temporarily
|
|
25
|
+
- Executes them immediately
|
|
26
|
+
- Doesn't require global installation
|
|
27
|
+
- Always uses the latest version
|
|
28
|
+
|
|
29
|
+
Perfect for testing or one-time use!
|
|
30
|
+
|
|
31
|
+
## Configuration
|
|
32
|
+
|
|
33
|
+
### Claude Desktop (Recommended)
|
|
34
|
+
|
|
35
|
+
Add to your Claude Desktop configuration file:
|
|
36
|
+
|
|
37
|
+
**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
38
|
+
**Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
|
|
39
|
+
|
|
40
|
+
```json
|
|
41
|
+
{
|
|
42
|
+
"mcpServers": {
|
|
43
|
+
"tenable-docs": {
|
|
44
|
+
"command": "npx",
|
|
45
|
+
"args": ["tenable-mcp-docs"]
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Other MCP Clients
|
|
52
|
+
|
|
53
|
+
Any MCP client that supports npx can use this package. The command is:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
npx tenable-mcp-docs
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## How it Works
|
|
60
|
+
|
|
61
|
+
1. **Download**: Script fetches `dist/index.js` from GitHub main branch
|
|
62
|
+
2. **Execute**: Node.js runs the downloaded server
|
|
63
|
+
3. **Cleanup**: Temporary file deleted after process ends
|
|
64
|
+
4. **Update**: Next run downloads the latest version
|
|
65
|
+
|
|
66
|
+
### Advantages
|
|
67
|
+
|
|
68
|
+
- ✅ **No Installation**: Works immediately without `npm install`
|
|
69
|
+
- ✅ **Always Latest**: Gets the newest version from GitHub
|
|
70
|
+
- ✅ **No Local Files**: Doesn't clutter your filesystem
|
|
71
|
+
- ✅ **Easy Updates**: Always runs the latest code
|
|
72
|
+
- ✅ **Simple**: One command to run
|
|
73
|
+
|
|
74
|
+
### Network Requirements
|
|
75
|
+
|
|
76
|
+
- Internet connection (to download from GitHub)
|
|
77
|
+
- HTTPS access to `raw.githubusercontent.com`
|
|
78
|
+
|
|
79
|
+
## Available Tools
|
|
80
|
+
|
|
81
|
+
The server provides two MCP tools:
|
|
82
|
+
|
|
83
|
+
### 1. search_docs
|
|
84
|
+
|
|
85
|
+
Search Tenable documentation for relevant pages.
|
|
86
|
+
|
|
87
|
+
**Usage in Claude:**
|
|
88
|
+
```
|
|
89
|
+
User: How do I use the Tenable API?
|
|
90
|
+
Claude: Let me search the documentation...
|
|
91
|
+
[calls search_docs with "Tenable API"]
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### 2. read_page
|
|
95
|
+
|
|
96
|
+
Read a documentation page and convert to Markdown.
|
|
97
|
+
|
|
98
|
+
**Usage in Claude:**
|
|
99
|
+
```
|
|
100
|
+
Claude: I found relevant documentation. Let me read it...
|
|
101
|
+
[calls read_page with documentation URL]
|
|
102
|
+
Claude: Here's the information from the documentation...
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
## Troubleshooting
|
|
106
|
+
|
|
107
|
+
### "npx: command not found"
|
|
108
|
+
|
|
109
|
+
**Cause**: npx is not installed or not in PATH
|
|
110
|
+
|
|
111
|
+
**Solution**: npx comes with npm. Install [Node.js](https://nodejs.org/).
|
|
112
|
+
|
|
113
|
+
### "Failed to download server"
|
|
114
|
+
|
|
115
|
+
**Cause**: No internet connection or GitHub is down
|
|
116
|
+
|
|
117
|
+
**Solution**:
|
|
118
|
+
1. Check internet connection
|
|
119
|
+
2. Try accessing https://raw.githubusercontent.com/CatFoxVoyager/tenable-mcp-docs/main/dist/index.js
|
|
120
|
+
3. Check GitHub status: https://status.github.com/
|
|
121
|
+
|
|
122
|
+
### "Node.js is not installed"
|
|
123
|
+
|
|
124
|
+
**Solution**: Install Node.js from https://nodejs.org/
|
|
125
|
+
|
|
126
|
+
### Server Won't Start
|
|
127
|
+
|
|
128
|
+
**Cause**: Downloaded file is corrupted or incompatible Node version
|
|
129
|
+
|
|
130
|
+
**Solution**:
|
|
131
|
+
1. Ensure Node.js 18+ is installed
|
|
132
|
+
2. Check Node version: `node --version`
|
|
133
|
+
3. Try running with debug: `DEBUG=1 npx tenable-mcp-docs`
|
|
134
|
+
|
|
135
|
+
## Development
|
|
136
|
+
|
|
137
|
+
If you want to develop or modify the server:
|
|
138
|
+
|
|
139
|
+
```bash
|
|
140
|
+
# Clone the main repository
|
|
141
|
+
git clone https://github.com/CatFoxVoyager/tenable-mcp-docs
|
|
142
|
+
cd tenable-mcp-docs
|
|
143
|
+
|
|
144
|
+
# Install dependencies
|
|
145
|
+
npm install
|
|
146
|
+
|
|
147
|
+
# Build
|
|
148
|
+
npm run build
|
|
149
|
+
|
|
150
|
+
# Run locally
|
|
151
|
+
npm start
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
See the main repository for documentation and contribution guidelines.
|
|
155
|
+
|
|
156
|
+
## License
|
|
157
|
+
|
|
158
|
+
MIT License
|
|
159
|
+
|
|
160
|
+
## Links
|
|
161
|
+
|
|
162
|
+
- [Main Repository](https://github.com/CatFoxVoyager/tenable-mcp-docs)
|
|
163
|
+
- [npm Package](https://www.npmjs.com/package/tenable-mcp-docs)
|
|
164
|
+
- [Tenable Developer Portal](https://developer.tenable.com/)
|
|
165
|
+
- [MCP Documentation](https://modelcontextprotocol.io/)
|
|
166
|
+
|
|
167
|
+
---
|
|
168
|
+
|
|
169
|
+
**Made with ❤️ for the Tenable developer community**
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
|
|
3
|
+
# Tenable Docs MCP Server Launcher
|
|
4
|
+
# This script downloads and executes the server from GitHub
|
|
5
|
+
|
|
6
|
+
set -e
|
|
7
|
+
|
|
8
|
+
# Colors for output
|
|
9
|
+
GREEN='\033[0;32m'
|
|
10
|
+
NC='\033[0m' # No Color
|
|
11
|
+
|
|
12
|
+
# Server download URL
|
|
13
|
+
SERVER_URL="https://raw.githubusercontent.com/CatFoxVoyager/tenable-mcp-docs/main/dist/index.js"
|
|
14
|
+
TEMP_DIR="${TMPDIR:-/tmp}"
|
|
15
|
+
SERVER_FILE="${TEMP_DIR}/tenable-mcp-docs-server.js"
|
|
16
|
+
|
|
17
|
+
echo -e "${GREEN}Tenable Docs MCP Server${NC}"
|
|
18
|
+
echo "================================"
|
|
19
|
+
echo ""
|
|
20
|
+
|
|
21
|
+
# Check if Node.js is available
|
|
22
|
+
if ! command -v node &> /dev/null; then
|
|
23
|
+
echo "Error: Node.js is not installed or not in PATH"
|
|
24
|
+
echo "Please install Node.js from https://nodejs.org/"
|
|
25
|
+
exit 1
|
|
26
|
+
fi
|
|
27
|
+
|
|
28
|
+
NODE_VERSION=$(node --version)
|
|
29
|
+
echo "Node.js version: ${NODE_VERSION}"
|
|
30
|
+
echo ""
|
|
31
|
+
|
|
32
|
+
# Download the server
|
|
33
|
+
echo "Downloading server from GitHub..."
|
|
34
|
+
curl -fsSL "${SERVER_URL}" -o "${SERVER_FILE}"
|
|
35
|
+
|
|
36
|
+
if [ $? -ne 0 ]; then
|
|
37
|
+
echo "Error: Failed to download server"
|
|
38
|
+
echo "Please check your internet connection"
|
|
39
|
+
exit 1
|
|
40
|
+
fi
|
|
41
|
+
|
|
42
|
+
echo "Server downloaded successfully"
|
|
43
|
+
echo ""
|
|
44
|
+
|
|
45
|
+
# Execute the server with all arguments
|
|
46
|
+
exec node "${SERVER_FILE}" "$@"
|
package/package.json
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "tenable-mcp-docs",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "MCP server for retrieving Tenable documentation to assist with script generation. Run via npx to use immediately without installation.",
|
|
5
|
+
"bin": {
|
|
6
|
+
"tenable-mcp-docs": "bin/tenable-mcp-docs"
|
|
7
|
+
},
|
|
8
|
+
"keywords": [
|
|
9
|
+
"mcp",
|
|
10
|
+
"model-context-protocol",
|
|
11
|
+
"tenable",
|
|
12
|
+
"documentation",
|
|
13
|
+
"api"
|
|
14
|
+
],
|
|
15
|
+
"author": "",
|
|
16
|
+
"license": "MIT",
|
|
17
|
+
"repository": {
|
|
18
|
+
"type": "git",
|
|
19
|
+
"url": "https://github.com/CatFoxVoyager/tenable-mcp-docs"
|
|
20
|
+
},
|
|
21
|
+
"homepage": "https://github.com/CatFoxVoyager/tenable-mcp-docs#readme"
|
|
22
|
+
}
|