ping
Read-onlyIdempotent
Check if the Minestom MCP server is reachable by sending an optional message and receiving an 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. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| echoedMessage | Yes | ||
| ok | Yes | ||
| timestamp | Yes |
Implementation Reference
- src/minestom/meta.ts:21-35 (handler)The ping tool handler function that parses input, echoes a message (or 'pong'), and returns an ok status with a timestamp.
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, }).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-13 (schema)Input schema for the ping tool: accepts an optional 'message' string to echo back.
const pingInputSchema = z.object({ message: z .string() .optional() .describe("Optional text to echo back in the response."), }); - src/minestom/meta.ts:15-19 (schema)Output schema for the ping tool: returns echoedMessage, ok boolean, and timestamp string.
const pingOutputSchema = z.object({ echoedMessage: z.string(), ok: z.boolean(), timestamp: z.string(), }); - src/tools.ts:18-28 (registration)Registration of pingTool into the serverTools array alongside other tools.
tools.push( pingTool, createGetServerInfoTool(toolNames), inspectMinestomEnvironmentTool, inspectMinestomBuildTool, explainMinestomPatternTool, lookupMinestomApiTool, planMinestomFeatureTool, reviewMinestomDesignTool, suggestMinestomLibrariesTool, );