Skip to content

Commit 239eb6d

Browse files
authored
Merge pull request #83 from Azure/guwe/readme2
docs: tools documentation
2 parents 6c47713 + 0206d0c commit 239eb6d

File tree

1 file changed

+82
-6
lines changed

1 file changed

+82
-6
lines changed

README.md

Lines changed: 82 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -158,19 +158,73 @@ Show me the network security groups associated with my cluster.
158158
The AKS-MCP server provides the following tools for interacting with AKS clusters:
159159
160160
<details>
161-
<summary>Cluster Tools</summary>
161+
<summary>AKS Cluster Management Tools (Read-Only)</summary>
162+
163+
- `az_aks_show`: Show the details of a managed Kubernetes cluster
164+
- `az_aks_list`: List managed Kubernetes clusters
165+
- `az_aks_get-versions`: Get the versions available for creating a managed Kubernetes cluster
166+
- `az_aks_check-network_outbound`: Perform outbound network connectivity check for a node
167+
- `az_aks_nodepool_list`: List node pools in a managed Kubernetes cluster
168+
- `az_aks_nodepool_show`: Show the details for a node pool in the managed Kubernetes cluster
169+
</details>
170+
171+
<details>
172+
<summary>AKS Cluster Management Tools (Read-Write)</summary>
173+
174+
*Available with `--access-level readwrite` or `admin`*
175+
176+
- `az_aks_create`: Create a new managed Kubernetes cluster
177+
- `az_aks_delete`: Delete a managed Kubernetes cluster
178+
- `az_aks_scale`: Scale the node pool in a managed Kubernetes cluster
179+
- `az_aks_update`: Update a managed Kubernetes cluster
180+
- `az_aks_upgrade`: Upgrade a managed Kubernetes cluster to a newer version
181+
- `az_aks_nodepool_add`: Add a node pool to the managed Kubernetes cluster
182+
- `az_aks_nodepool_delete`: Delete a node pool from the managed Kubernetes cluster
183+
- `az_aks_nodepool_scale`: Scale a node pool in a managed Kubernetes cluster
184+
- `az_aks_nodepool_upgrade`: Upgrade a node pool to a newer version
185+
</details>
162186
163-
- `get_cluster_info`: Get detailed information about an AKS cluster
164-
- `list_aks_clusters`: List all AKS clusters in a subscription and optional resource group
187+
<details>
188+
<summary>AKS Cluster Management Tools (Admin)</summary>
189+
190+
*Available with `--access-level admin` only*
191+
192+
- `az_aks_get-credentials`: Get access credentials for a managed Kubernetes cluster
165193
</details>
166194
167195
<details>
168196
<summary>Network Tools</summary>
169197
170198
- `get_vnet_info`: Get information about the VNet used by the AKS cluster
171-
- `get_subnet_info`: Get information about the subnets used by the AKS cluster
172-
- `get_route_table_info`: Get information about the route tables used by the AKS cluster
173-
- `get_nsg_info`: Get information about the network security groups used by the AKS cluster
199+
- `get_subnet_info`: Get information about the Subnet used by the AKS cluster
200+
- `get_route_table_info`: Get information about the Route Table used by the AKS cluster
201+
- `get_nsg_info`: Get information about the Network Security Group used by the AKS cluster
202+
- `get_load_balancers_info`: Get information about all Load Balancers used by the AKS cluster
203+
- `get_private_endpoint_info`: Get information about the private endpoint used by the AKS cluster
204+
</details>
205+
206+
<details>
207+
<summary>Compute Tools</summary>
208+
209+
- `get_aks_vmss_info`: Get detailed VMSS configuration for node pools in the AKS cluster
210+
- `az_vmss_run-command_invoke`: Execute a command on instances of a Virtual Machine Scale Set (readwrite/admin)
211+
</details>
212+
213+
<details>
214+
<summary>Monitor Tools</summary>
215+
216+
- `az_monitor_metrics_list`: List the metric values for a resource
217+
- `az_monitor_metrics_list-definitions`: List the metric definitions for a resource
218+
- `az_monitor_metrics_list-namespaces`: List the metric namespaces for a resource
219+
- `az_monitor_activity_log_resource_health`: Retrieve resource health events for AKS clusters
220+
- `az_monitor_app_insights_query`: Execute KQL queries against Application Insights telemetry data
221+
</details>
222+
223+
<details>
224+
<summary>AKS Control Plane Tools</summary>
225+
226+
- `aks_control_plane_diagnostic_settings`: Check if AKS cluster has diagnostic settings configured
227+
- `aks_control_plane_logs`: Query AKS control plane logs with safety constraints and time range validation
174228
</details>
175229
176230
<details>
@@ -182,6 +236,28 @@ The AKS-MCP server provides the following tools for interacting with AKS cluster
182236
- Requires readwrite or admin access for write operations
183237
</details>
184238
239+
<details>
240+
<summary>Detector Tools</summary>
241+
242+
- `list_detectors`: List all available AKS cluster detectors
243+
- `run_detector`: Run a specific AKS detector
244+
- `run_detectors_by_category`: Run all detectors in a specific category
245+
</details>
246+
247+
<details>
248+
<summary>Azure Advisor Tools</summary>
249+
250+
- `az_advisor_recommendation`: Retrieve and manage Azure Advisor recommendations for AKS clusters
251+
</details>
252+
253+
<details>
254+
<summary>Account Management Tools</summary>
255+
256+
- `az_account_list`: List all subscriptions for the authenticated account
257+
- `az_account_set`: Set a subscription as the current active subscription
258+
- `az_login`: Log in to Azure using service principal credentials
259+
</details>
260+
185261
## Contributing
186262
187263
This project welcomes contributions and suggestions. Most contributions require you to agree to a

0 commit comments

Comments
 (0)