checkConnectivity
Test TCP connectivity to a specified host and port to diagnose network connection issues with configurable timeout settings.
Instructions
Test TCP connectivity to a host and port
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| host | Yes | Target host | |
| port | Yes | Target port | |
| timeout | No | Connection timeout in milliseconds |
Implementation Reference
- src/tools/network.ts:50-82 (handler)The core handler function implementing the TCP connectivity check using Node.js net module. It creates a socket connection, handles connect, timeout, error, and close events, and resolves with a JSON-formatted result.handler: async ({ host, port, timeout = 5000 }: { host: string; port: number; timeout?: number }) => { return new Promise<{ content: Array<{ type: string, text: string }> }>((resolve) => { const result: NetworkConnectivityResult = { connected: false }; const socket = createConnection(port, host); socket.setTimeout(timeout); socket.on('connect', () => { result.connected = true; socket.end(); }); socket.on('timeout', () => { result.error = 'Connection timed out'; socket.destroy(); }); socket.on('error', (err) => { result.error = err.message; }); socket.on('close', () => { resolve({ content: [{ type: 'text', text: JSON.stringify(result, null, 2) }] }); }); }); }
- src/tools/network.ts:31-49 (schema)Input schema defining the parameters for the checkConnectivity tool: host (string, required), port (number, required), timeout (number, optional default 5000).inputSchema: { type: 'object', properties: { host: { type: 'string', description: 'Target host' }, port: { type: 'number', description: 'Target port' }, timeout: { type: 'number', description: 'Connection timeout in milliseconds', default: 5000 } }, required: ['host', 'port'] },
- src/tools/network.ts:28-83 (registration)The complete tool definition object for 'checkConnectivity', including name, description, inputSchema, and handler, exported as part of networkTools.checkConnectivity: { name: 'checkConnectivity', description: 'Test TCP connectivity to a host and port', inputSchema: { type: 'object', properties: { host: { type: 'string', description: 'Target host' }, port: { type: 'number', description: 'Target port' }, timeout: { type: 'number', description: 'Connection timeout in milliseconds', default: 5000 } }, required: ['host', 'port'] }, handler: async ({ host, port, timeout = 5000 }: { host: string; port: number; timeout?: number }) => { return new Promise<{ content: Array<{ type: string, text: string }> }>((resolve) => { const result: NetworkConnectivityResult = { connected: false }; const socket = createConnection(port, host); socket.setTimeout(timeout); socket.on('connect', () => { result.connected = true; socket.end(); }); socket.on('timeout', () => { result.error = 'Connection timed out'; socket.destroy(); }); socket.on('error', (err) => { result.error = err.message; }); socket.on('close', () => { resolve({ content: [{ type: 'text', text: JSON.stringify(result, null, 2) }] }); }); }); } },
- src/types.ts:31-34 (schema)TypeScript interface defining the structure of the connectivity check result: connected (boolean) and optional error (string). Used in the handler.export interface NetworkConnectivityResult { connected: boolean; error?: string; }
- src/index.ts:28-35 (registration)Registration of all tools including networkTools (which contains checkConnectivity) into the allTools object used by MCP server handlers for listing and calling tools.const allTools: ToolKit = { ...systemTools, ...networkTools, ...geoTools, ...generatorTools, ...dateTimeTools, ...securityTools };