Frappe MCP Server

🚀 Frappe Framework User Guide

This guide provides a comprehensive introduction to the Frappe framework, including installation, configuration, core function modules, development, and best practices. It helps you efficiently develop and maintain your web applications.

🚀 Quick Start

📦 Installation

1. Download the Installation Package: Download the latest version of the installation package suitable for your operating system from the Frappe official website.
2. Prepare the Environment:
   • Ensure that your system has Python 3.7 or a higher version installed.
   • Install the PostgreSQL database and make sure its version is 10 or higher.
3. Execute the Installation Script: Run the setup.py script in the downloaded installation package. Follow the prompts to complete the installation process.
4. Initialize the Configuration:
   • Execute the frappe init command to create a new project.
   • Select the required application modules as prompted and complete the initialization settings.
5. Start the Service: Use the command python3 -m frappe serve to start the Frappe service. The default port is 8000.

⚙️ Environment Variable Configuration

• FRAPPE_SITE_URL: Set your Frappe site URL, for example, http://localhost:8000.
• FRAPPE_SECRET_KEY: Used for API call key generation, defaulting to a random string.
• DATABASE_URI: The database connection URI is in the format postgresql://username:password@host/database_name.

✨ Features

Doctype Management

Create and Edit Document Types

1. Create a New Doctype:
   • Create a new JSON file named doctype_name.json in the doc directory of Frappe.
   • Define the field structure and validation rules.
2. Customize the Doctype Form:
   • Use HTML and JavaScript to create the form interface and save it as doctype_name.html.
   • Add event listeners and custom functions in doctype_name.js.
3. Enable and Disable Document Types:
   • Go to the system settings of Frappe, find the Doctype management module, and select the required operation.

Document Type Example

# Example document type structure
{
  "doctype": "Customer",
  "fields": [
    {"label": "Customer Name", "fieldname": "customer_name", "type": "Data"},
    {"label": "Customer Type", "fieldname": "customer_type", "type": "Select", "options": ["Individual", "Company"]}
  ],
  "validation": {
    "required_fields": ["customer_name"],
    "unique": ["customer_email"]
  }
}

Database Interaction

Query Data

1. Basic Query:
   • Use frappe.get_all to get a list of records, supporting filtering and sorting.

   customers = frappe.get_all('Customer', filters={'customer_type': 'Individual'}, fields=['name', 'customer_name'])
   

2. Insert Data:
   • Call the frappe.insert method to add a new document.

   new_customer = {
     "doctype": "Customer",
     "customer_name": "John Doe",
     "customer_type": "Individual"
   }
   frappe.insert(new_customer)
   

3. Update Data:
   • Use the frappe.update method to modify an existing record.

   frappe.update('Customer', 'CUST-00001', {'email_id': 'john@example.com'})
   

4. Delete Data:
   • Call the frappe.delete method to delete a specified document.

   frappe.delete('Customer', 'CUST-00001')
   

Form Validation and Events

Custom Form Validation

// Example validation function
frappe.add_events("Customer", {
  "on_submit": function(doc) {
    if (!doc.customer_name) {
      throw new frappe.ValidationError("Please enter the customer name");
    }
  }
});

📚 Documentation

Plugin Development Guide

1. Create the Plugin Structure:
   • Create a new plugins folder in the project root directory.
   • Create the plugin main file plugin_name.js and the configuration file plugin_name.json.
2. Register Custom Events:

   frappe.plugins.register('my_plugin', {
     onReady: function() {
       console.log("Plugin loaded");
     }
   });
   

3. Extend Document Types:
   • Add custom methods and event listeners in doctype_name.js.

API Usage Instructions

1. Get an Access Token:

   curl --user admin:admin_pass http://localhost:8000/api/method/frappe.auth.get_token
   

2. Call the REST API:

   curl -X GET "http://localhost:8000/api/resource/doctype/Customer"
   

3. Handle File Uploads:

   curl -F file=@/path/to/image.jpg "http://localhost:8000/api/method/frappe.core.doctype.file_manager.upload_file"
   

🔧 Technical Details

Best Practices

Performance Optimization

1. Optimize Database Indexes:
   • Create indexes on frequently queried fields to improve query efficiency.

   CREATE INDEX idx_customer_name ON Customer(customer_name);
   

2. Apply Caching Mechanisms:
   • Use the frappe.cache module to cache frequently accessed data and reduce database load.
3. Handle Asynchronous Tasks:
   • Use tools such as Celery to implement task queues and improve system response speed.

Security Precautions

1. Control Permissions:
   • Configure appropriate roles and permissions to ensure minimal user permissions.

   frappe.add_perm("Customer", "Sales User", "read");
   

2. Enable Logging:
   • Enable detailed logging to monitor system behavior and detect anomalies in a timely manner.
3. Conduct Regular Security Audits:
   • Regularly check system vulnerabilities, update components to the latest versions, and ensure system security.

By following these guides and best practices, you can efficiently use the Frappe framework to develop and maintain your web applications.