get-catalog-nodes
Retrieve catalog nodes from the Consul MCP Server to access and manage services, health checks, KV store, and other Consul functionalities efficiently.
Instructions
Get nodes from the catalog
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/consulTools.ts:256-269 (handler)Handler function that lists all nodes from Consul catalog using consul.catalog.node.list(), formats them with formatCatalogNode, and returns formatted text.
async () => { try { const data = await consul.catalog.node.list(); if (!data || data.length === 0) { return { content: [{ type: "text", text: "No nodes found in the catalog" }] }; } const nodesText = `Catalog nodes:\n\n${data.map(formatCatalogNode).join("\n")}`; return { content: [{ type: "text", text: nodesText }] }; } catch (error) { console.error("Error getting catalog nodes:", error); return { content: [{ type: "text", text: "Error getting catalog nodes" }] }; } } - src/tools/consulTools.ts:252-270 (registration)Registers the 'get-catalog-nodes' tool on the McpServer with empty input schema and the handler function.
server.tool( "get-catalog-nodes", "Get nodes from the catalog", {}, async () => { try { const data = await consul.catalog.node.list(); if (!data || data.length === 0) { return { content: [{ type: "text", text: "No nodes found in the catalog" }] }; } const nodesText = `Catalog nodes:\n\n${data.map(formatCatalogNode).join("\n")}`; return { content: [{ type: "text", text: nodesText }] }; } catch (error) { console.error("Error getting catalog nodes:", error); return { content: [{ type: "text", text: "Error getting catalog nodes" }] }; } } ); - src/utils/formatter.ts:29-39 (helper)Helper function used by the handler to format each CatalogNode into a readable string.
export function formatCatalogNode(node: CatalogNode): string { return [ `Node: ${node.Node || "Unknown"}`, `Address: ${node.Address || "Unknown"}`, `ServiceID: ${node.ServiceID || "Unknown"}`, `ServiceName: ${node.ServiceName || "Unknown"}`, `ServicePort: ${node.ServicePort || "Unknown"}`, `ServiceTags: ${node.ServiceTags?.join(", ") || "None"}`, "---", ].join("\n"); }