Home / impertio-studio / frappe_claude_skill_package · skills/source/syntax/frappe-syntax-whitelisted/SKILL.md · GitHub

frappe-syntax-whitelisted skillA

frappe-syntax-whitelisted is agent-read markdown (skill) from impertio-studio/frappe_claude_skill_package: Use when creating Frappe Whitelisted Methods (Python API endpoints) for v14/v15/v16. Covers @frappe.whitelist() decorator, frappe.call/frm.call invocations, permission checks, error handling, response formats, and client-server communication. Keywords: whitelisted, API endpoint, frappe.call, frm.call, REST API, @frappe.whitelist, allow_guest, API endpoint example, frappe.whitelist syntax, how to expose function..

Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns the same grade.

What the file says

# Frappe Syntax: Whitelisted Methods

Whitelisted methods expose Python functions as HTTP API endpoints via `/api/method/`.

## Quick Reference

```python
import frappe
from frappe import _

# Authenticated endpoint (default)
@frappe.whitelist()
def get_customer_summary(customer):
    frappe.has_permission("Customer", "read", throw=True)
    return frappe.get_doc("Customer", customer).as_dict()

# Public endpoint — ALWAYS validate input thoroughly
@frappe.whitelist(allow_guest=True, methods=["POST"])
def submit_contact(name, email, message):
    if not name or not email:
        frappe.throw(_("Name and email required"), frappe.ValidationError)
    return {"success": True}

# Controller method — called via frm.call('method_name')
class SalesOrder(Document):
    @frappe.whitelist()
    def calculate_taxes(self, include_shipping=False):
        return {"tax": self.grand_total * 0.21}
```

**Endpoint URL**: `/api/method/myapp.module.function_name`

---

## Decorator Signature [v14+]

```python
@frappe.whitelist(
    allow_guest=False,   # True = accessible without login
    xss_safe=False,      # True = do NOT escape HTML in response
…

Read the whole file at its exact version.

How to install

Latest version
mdr add impertio-studio/frappe_claude_skill_package/frappe-syntax-whitelisted@v2.0
Exact content
mdr add impertio-studio/frappe_claude_skill_package/frappe-syntax-whitelisted@sha256:8009b5af8b9ff828

Pin to a label to follow the author's releases, or to a sha256 to freeze the exact bytes forever. Either way the resolved hash is written to mdr.lock, and mdr install reproduces it on any machine.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_lr2ekt6y25xhxdqa.svg)](https://markdownregistry.com/a/art_lr2ekt6y25xhxdqa)

1 badge views in 30 days

Versions

versioncommittedcommitsizeaudit
v2.0 latest2026-03-30 d83dc82 11,524 BA view · diff
v2.02026-03-30 875ff50 11,451 BA view · diff
v2.02026-03-20 7aa2bb1 11,457 BA view · diff
v2.02026-03-20 191313a 9,162 BA view

Audit of the latest version

A  17 of 17 checks passed. Deterministic, no model, same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (11524 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

impertio-studio/frappe_claude_skill_package · 182 stars · license NOASSERTION · pushed 2026-09-17 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_lr2ekt6y25xhxdqa
GET https://markdownregistry.com/api/v1/resolve?ref=impertio-studio/frappe_claude_skill_package/frappe-syntax-whitelisted
GET https://markdownregistry.com/api/v1/blob/8009b5af8b9ff8282911364c6195e067d8a2afc35170cb3f9ac8ab24ff80345a

Your agent does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

More from impertio-studio/frappe_claude_skill_package

CLAUDE.md claude
impertio-studio/frappe_claude_skill_package · CLAUDE.md
git:20260401.36cfa80 · audit A · 182 stars
frappe-agent-architect skill
impertio-studio/frappe_claude_skill_package · skills/source/agents/frappe-agent-architect/SKILL.md · Use when designing multi-app Frappe architectures, deciding whether to split functionality into separate apps, or…
v2.0 · audit A · 182 stars
frappe-agent-debugger skill
impertio-studio/frappe_claude_skill_package · skills/source/agents/frappe-agent-debugger/SKILL.md · Use when debugging Frappe errors, using bench console for live inspection, analyzing tracebacks, or reading Frappe log…
v2.0 · audit A · 182 stars
frappe-agent-interpreter skill
impertio-studio/frappe_claude_skill_package · skills/source/agents/frappe-agent-interpreter/SKILL.md · Use when receiving vague or unclear ERPNext/Frappe development requests that need interpretation. Transforms…
v2.0 · audit A · 182 stars
frappe-agent-migrator skill
impertio-studio/frappe_claude_skill_package · skills/source/agents/frappe-agent-migrator/SKILL.md · Use when migrating a Frappe app between major versions, detecting breaking API changes, or resolving post-migration…
v2.0 · audit A · 182 stars
frappe-agent-validator skill
impertio-studio/frappe_claude_skill_package · skills/source/agents/frappe-agent-validator/SKILL.md · Use when reviewing or validating Frappe/ERPNext code against best practices and common pitfalls. Checks generated code…
v2.0 · audit A · 182 stars
frappe-core-api skill
impertio-studio/frappe_claude_skill_package · skills/source/core/frappe-core-api/SKILL.md · Use when building ERPNext/Frappe API integrations (v14/v15/v16) including REST API, RPC API, authentication, webhooks…
v2.0 · audit A · 182 stars
frappe-core-cache skill
impertio-studio/frappe_claude_skill_package · skills/source/core/frappe-core-cache/SKILL.md · Use when implementing Redis caching, cache invalidation, or distributed locking in Frappe. Prevents stale cache bugs…
v2.0 · audit A · 182 stars
frappe-core-database skill
impertio-studio/frappe_claude_skill_package · skills/source/core/frappe-core-database/SKILL.md · Use when performing database operations in ERPNext/Frappe v14-v16. Covers frappe.db methods, ORM patterns…
v2.0 · audit A · 182 stars
frappe-core-files skill
impertio-studio/frappe_claude_skill_package · skills/source/core/frappe-core-files/SKILL.md · Use when handling file uploads, attachments, private/public file access, or S3 storage configuration. Prevents broken…
v2.0 · audit A · 182 stars
frappe-core-logging skill
impertio-studio/frappe_claude_skill_package · skills/source/core/frappe-core-logging/SKILL.md · Use when implementing logging, error tracking, or monitoring in Frappe v14-v16. Covers frappe.logger() for file-based…
v3.0 · audit A · 182 stars
frappe-core-notifications skill
impertio-studio/frappe_claude_skill_package · skills/source/core/frappe-core-notifications/SKILL.md · Use when implementing email notifications, system alerts, Assignment Rules, Auto Repeat, or ToDo items. Prevents…
v2.0 · audit A · 182 stars

Every file in impertio-studio/frappe_claude_skill_package

Browse by kind, by grade A, or by owner.