get_document
Retrieve specific documents from Frappe Framework by providing the document type and case-sensitive name to access stored data efficiently.
Instructions
Retrieve a document from Frappe.
Args:
doctype: DocType name
name: Document name (case-sensitive)
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| doctype | Yes | ||
| name | Yes |
Implementation Reference
- src/tools/documents.py:122-147 (handler)The main handler function for the 'get_document' tool. It fetches the specified Frappe document via the REST API and returns its JSON data, with error handling.@mcp.tool() async def get_document( doctype: str, name: str ) -> str: """ Retrieve a document from Frappe. Args: doctype: DocType name name: Document name (case-sensitive) """ try: client = get_client() # Make API request to get document response = await client.get(f"api/resource/{doctype}/{name}") if "data" in response: return json.dumps(response["data"], indent=2) else: return json.dumps(response, indent=2) except Exception as error: return _format_error_response(error, "get_document")
- src/server.py:39-42 (registration)The registration call for the documents module's tools, which includes the get_document tool via its register_tools function.helpers.register_tools(mcp) documents.register_tools(mcp) schema.register_tools(mcp) reports.register_tools(mcp)
- src/tools/documents.py:123-133 (schema)Type hints and docstring defining the input schema (doctype: str, name: str) and output (str: JSON data).async def get_document( doctype: str, name: str ) -> str: """ Retrieve a document from Frappe. Args: doctype: DocType name name: Document name (case-sensitive) """
- src/tools/documents.py:51-79 (helper)Helper function used by get_document for formatting and returning detailed error responses.def _format_error_response(error: Exception, operation: str) -> str: """Format error response with detailed information.""" credentials_check = validate_api_credentials() # Build diagnostic information diagnostics = [ f"Error in {operation}", f"Error type: {type(error).__name__}", f"Is FrappeApiError: {isinstance(error, FrappeApiError)}", f"API Key available: {credentials_check['details']['api_key_available']}", f"API Secret available: {credentials_check['details']['api_secret_available']}" ] # Check for missing credentials first if not credentials_check["valid"]: error_msg = f"Authentication failed: {credentials_check['message']}. " error_msg += "API key/secret is the only supported authentication method." return error_msg # Handle FrappeApiError if isinstance(error, FrappeApiError): error_msg = f"Frappe API error: {error}" if error.status_code in (401, 403): error_msg += " Please check your API key and secret." return error_msg # Default error handling return f"Error in {operation}: {str(error)}"