get_nodes_overview
Retrieve an overview of infrastructure nodes, including health status, resource utilization, running containers, and system metrics, with optional search/filter by query.
Instructions
Get overview of infrastructure nodes.
Returns information about all nodes in the infrastructure:
Node health and status
Resource utilization
Running containers
System metrics
Args: project_id: Project ID query: Search/filter query (optional)
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | ||
| query | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/mcp_coroot/server.py:436-453 (registration)MCP tool registration via @mcp.tool() decorator for get_nodes_overview
@mcp.tool() async def get_nodes_overview( project_id: str, query: str | None = None, ) -> dict[str, Any]: """Get overview of infrastructure nodes. Returns information about all nodes in the infrastructure: - Node health and status - Resource utilization - Running containers - System metrics Args: project_id: Project ID query: Search/filter query (optional) """ return await get_nodes_overview_impl(project_id, query) # type: ignore[no-any-return] - src/mcp_coroot/server.py:423-433 (handler)Handler function that calls client to get nodes overview data
@handle_errors async def get_nodes_overview_impl( project_id: str, query: str | None = None, ) -> dict[str, Any]: """Get nodes overview.""" overview = await get_client().get_nodes_overview(project_id, query) return { "success": True, "overview": overview, } - src/mcp_coroot/client.py:494-518 (handler)CorootClient method that makes the actual HTTP GET request to /api/project/{project_id}/overview/nodes
async def get_nodes_overview( self, project_id: str, query: str | None = None, ) -> dict[str, Any]: """Get infrastructure nodes overview. Args: project_id: Project ID. query: Search/filter query. Returns: Nodes overview data. """ params = {} if query: params["query"] = query response = await self._request( "GET", f"/api/project/{project_id}/overview/nodes", params=params, ) data: dict[str, Any] = response.json() return data