ping
Check if the Frappe MCP Server is responding to verify connectivity and server status.
Instructions
A simple tool to check if the server is responding.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Implementation Reference
- src/tools/helpers.py:17-20 (handler)The ping tool handler: a simple function that returns 'pong' to confirm server responsiveness.
@mcp.tool() def ping() -> str: """A simple tool to check if the server is responding.""" return "pong" - src/server.py:39-39 (registration)Registration of the helpers module tools, including ping, with the MCP server instance.
helpers.register_tools(mcp) - src/tools/helpers.py:14-30 (registration)The register_tools function in helpers.py that defines and registers the ping tool 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()