ping
Check server responsiveness to verify connectivity and operational status of the Frappe MCP Server, ensuring reliable communication for document operations and API access.
Instructions
A simple tool to check if the server is responding.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/helpers.py:17-20 (handler)The handler function for the 'ping' tool, which returns 'pong' to confirm the server is responding.@mcp.tool() def ping() -> str: """A simple tool to check if the server is responding.""" return "pong"
- src/tools/helpers.py:14-30 (registration)The registration function that defines and registers the 'ping' tool (along with version and validate_auth) using the @mcp.tool() decorator.def register_tools(mcp: Any) -> None: """Register helper tools with the MCP server.""" @mcp.tool() def ping() -> str: """A simple tool to check if the server is responding.""" return "pong" @mcp.tool() def version() -> str: """Get version information for the Frappe MCP server.""" return f"Frappe MCP Server version {__version__}" @mcp.tool() def validate_auth() -> Dict[str, Any]: """Validate API credentials and return authentication status.""" return validate_api_credentials()
- src/server.py:39-39 (registration)Invokes the helpers.register_tools() to register the 'ping' tool on the MCP server instance.helpers.register_tools(mcp)