ping
Verify connectivity to the Minestom MCP server by sending a test request and receiving an optional echo response.
Instructions
Use this when you want to verify that the Minestom MCP server is reachable.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| message | No | Optional text to echo back in the response. |
Implementation Reference
- src/minestom/meta.ts:27-35 (handler)The handler function for the "ping" tool.
}).server(async (args) => { const { message } = pingInputSchema.parse(args); return pingOutputSchema.parse({ echoedMessage: message ?? "pong", ok: true, timestamp: new Date().toISOString(), }); }); - src/minestom/meta.ts:8-19 (schema)Input and output schemas for the "ping" tool defined using zod.
const pingInputSchema = z.object({ message: z .string() .optional() .describe("Optional text to echo back in the response."), }); const pingOutputSchema = z.object({ echoedMessage: z.string(), ok: z.boolean(), timestamp: z.string(), }); - src/minestom/meta.ts:21-26 (registration)Registration of the "ping" tool definition.
export const pingTool: TanStackServerTool = toolDefinition({ description: "Use this when you want to verify that the Minestom MCP server is reachable.", inputSchema: pingInputSchema, name: "ping", outputSchema: pingOutputSchema,