Skip to content

Commit 0e8d42e

Browse files
committed
Update docs.
1 parent d4e6319 commit 0e8d42e

File tree

3 files changed

+67
-0
lines changed

3 files changed

+67
-0
lines changed

docs/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@
101101
- `delete` - Delete a jumphost created by `osdctl jumphost create`
102102
- `mc` -
103103
- `list` - List ROSA HCP Management Clusters
104+
- `mcp` - Start osdctl in MCP server mode
104105
- `network` - network related utilities
105106
- `packet-capture` - Start packet capture
106107
- `verify-egress` - Verify an AWS OSD/ROSA cluster can reach all required external URLs necessary for full support.
@@ -3026,6 +3027,32 @@ osdctl mc list [flags]
30263027
-S, --skip-version-check skip checking to see if this is the most recent release
30273028
```
30283029

3030+
### osdctl mcp
3031+
3032+
Start osdctl as model-context-protocol server for integration with AI assistants.
3033+
3034+
```
3035+
osdctl mcp [flags]
3036+
```
3037+
3038+
#### Flags
3039+
3040+
```
3041+
--as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
3042+
--cluster string The name of the kubeconfig cluster to use
3043+
--context string The name of the kubeconfig context to use
3044+
-h, --help help for mcp
3045+
--http Use an HTTP server instead of stdio
3046+
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
3047+
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
3048+
-o, --output string Valid formats are ['', 'json', 'yaml', 'env']
3049+
--port int HTTP Server port to use when running in HTTP mode (default 8080)
3050+
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
3051+
-s, --server string The address and port of the Kubernetes API server
3052+
--skip-aws-proxy-check aws_proxy Don't use the configured aws_proxy value
3053+
-S, --skip-version-check skip checking to see if this is the most recent release
3054+
```
3055+
30293056
### osdctl network
30303057

30313058
network related utilities

docs/osdctl.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ CLI tool to provide OSD related utilities
3838
* [osdctl jira](osdctl_jira.md) - Provides a set of commands for interacting with Jira
3939
* [osdctl jumphost](osdctl_jumphost.md) -
4040
* [osdctl mc](osdctl_mc.md) -
41+
* [osdctl mcp](osdctl_mcp.md) - Start osdctl in MCP server mode
4142
* [osdctl network](osdctl_network.md) - network related utilities
4243
* [osdctl org](osdctl_org.md) - Provides information for a specified organization
4344
* [osdctl promote](osdctl_promote.md) - Utilities to promote services/operators

docs/osdctl_mcp.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## osdctl mcp
2+
3+
Start osdctl in MCP server mode
4+
5+
### Synopsis
6+
7+
Start osdctl as model-context-protocol server for integration with AI assistants.
8+
9+
```
10+
osdctl mcp [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for mcp
17+
--http Use an HTTP server instead of stdio
18+
--port int HTTP Server port to use when running in HTTP mode (default 8080)
19+
```
20+
21+
### Options inherited from parent commands
22+
23+
```
24+
--as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
25+
--cluster string The name of the kubeconfig cluster to use
26+
--context string The name of the kubeconfig context to use
27+
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
28+
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
29+
-o, --output string Valid formats are ['', 'json', 'yaml', 'env']
30+
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
31+
-s, --server string The address and port of the Kubernetes API server
32+
--skip-aws-proxy-check aws_proxy Don't use the configured aws_proxy value
33+
-S, --skip-version-check skip checking to see if this is the most recent release
34+
```
35+
36+
### SEE ALSO
37+
38+
* [osdctl](osdctl.md) - OSD CLI
39+

0 commit comments

Comments
 (0)