Foxmayn Frappe CLI

Create a new document in a Frappe DocType. Provide field values as a JSON object. Returns the created document with all server-generated fields (name, creation date, etc.).

Permanently delete a Frappe document. This action cannot be undone. Returns a confirmation message on success.

Look up what ERPNext fills into a document row when an item is picked, as the desk does: the rate (price list rate, pricing rules), UOM, warehouse, accounts, taxes and stock levels. Nothing is written. ERPNext 15 or 16. doctype is the document the row is for: a sales one (Quotation, Sales Order, Delivery Note, Sales Invoice) with customer, or a purchase one (Supplier Quotation, Purchase Order, Purchase Receipt, Purchase Invoice, Material Request) with supplier; default Sales Invoice, or Purchase Invoice with supplier. Prices are not converted between currencies. Returns the row's fields.

Map an ERPNext document into the next one in its chain, as the desk's Create button does (items, taxes and links come across): Quotation to Sales Order; Sales Order to Sales Invoice or Delivery Note; Delivery Note to Sales Invoice; Purchase Order to Purchase Receipt or Purchase Invoice; Purchase Receipt to Purchase Invoice; Material Request to Purchase Order. ERPNext 15 or 16. Returns {draft}: an UNSAVED document, nothing is written. Save it with create_doc (doctype = to_doctype, data = draft), then submit_doc if it should be final. A Quotation made out to a Lead or Prospect with no customer i…

Look up what ERPNext fills into a document when a customer or supplier is picked, as the desk does: address and contact, price list, currency, taxes template, payment terms and, with an invoice doctype (Sales Invoice, Purchase Invoice), the receivable or payable account and the due date. Nothing is written. ERPNext 15 or 16. Give customer or supplier, not both; company is optional but the accounts, taxes and payment terms depend on it. Returns the fields.

Make a Payment Entry against a Sales Invoice, Sales Order, Purchase Invoice, Purchase Order or Dunning, as the desk's Create > Payment button does: ERPNext picks the party account, the bank or cash account, the payment type and the amount still outstanding. ERPNext 15 or 16. Returns {draft, warnings?}: an UNSAVED Payment Entry, nothing is written. Save it with create_doc (doctype 'Payment Entry', data = draft), then submit_doc. warnings says when the draft has no bank or cash account (set the Company's default or pass bank_account; the insert would fail) or when bank_account was not used becau…

Show an item's stock. With warehouse: the balance there (actual_qty, and valuation_rate with valuation), now or, with date, at the end of that day. Without warehouse: {item_code, rows, truncated}, one row per warehouse that holds any quantity or has a reservation, order or plan (actual, reserved, projected quantity, valuation rate), at most 504 rows. date and valuation need warehouse. The Item, and the Warehouse when given, must exist (a typo is not-found, not zero). Quantities keep the number the site sends. ERPNext 15 or 16.

Retrieve a single Frappe document by its DocType and name. Returns all fields of the document, or only the requested fields. Use this when you know the exact document identifier. For Single DocTypes (e.g. 'System Settings', 'HR Settings'), omit name — the DocType name is used automatically.

Everything around one document in one call, as the desk's form sidebar shows it: who changed which fields (the last 10 versions, newest first; each version lists changed fields with from/to, child-row changes as "items[2].qty"; changes to fields the user may not read are left out and counted in hidden_fields), comments, emails, attachments (names and URLs, not contents), assignments, shares, tags, the workflow log and the user's permissions on it. With links (default true), the number of linked documents per DocType as the Connections panel counts them (DocTypes from the DocType's dashboard, e…

Render a document with a print format, as HTML (frappe.www.printview.get_html_and_style): returns {html, style}, or {text} with text_only, which is the readable text without tags. Needs read access to the document. Rendering runs the DocType's before_print hook (app code), as printing in the desk does, so it may have side effects an app put there. Results over 512 KiB drop the style, then cut the HTML (truncated: true). For a PDF use the CLI: ffc pdf.

Get the definition of a Frappe DocType as the desk sees it (custom fields and Customize Form overrides applied): module, naming rule, submittability, permissions and all field metadata (fieldname, label, fieldtype, required, options, defaults, constraints). By default returns a compact view with zero-value noise and internal Frappe metadata stripped. Pass full=true for the raw response, or keys to select specific top-level properties.

List the workflow actions the current user can apply to a document in its current state (action, next_state, allowed). Empty when none apply.

List the files attached to a document (File documents with attached_to_doctype/attached_to_name), oldest first: name, file_name, file_url, is_private, file_size, attached_to_field, folder, creation. File contents are not returned.

List documents from a Frappe DocType with optional filtering, field selection, ordering, and pagination. Returns an array of document objects. Use this to search and browse records; page with start and limit rather than fetching everything.

List all DocTypes available on the Frappe site, optionally filtered by module. Returns name, module, and description for each DocType. Use this to discover what data types exist on the site.

List the site's Error Log, newest first (System Manager only). Answers {errors, hidden_by_policy}: each entry has method (its title), the document it concerns (reference_doctype, reference_name) and error, the last line of its traceback; entries about a DocType this server may not read are left out and counted in hidden_by_policy. Pass name for one entry with its full traceback. since counts back in the site's time zone. Reading does not mark entries as seen.

List the site's background jobs (RQ Job) that Redis still holds, newest first (System Manager only). Redis keeps finished and failed jobs only for a while. Each job has error, the last line of its traceback; pass name (a job_id) for one job with its arguments and full traceback (exc_info), which can hold any DocType's data. Answers {jobs, warning?}, or the job with name. On Frappe v15 at most 20 jobs come back, not necessarily the newest (warning): filter with status or queue.

List available reports on the Frappe site, optionally filtered by module. Returns report name, type, module, and reference DocType.

List the Frappe sites this MCP server serves: name, URL, how ffc signs in, and whether MCP may only read it. When the server serves several sites, every other tool requires one of these names in its site argument; there is no default.

Check that the Frappe site is reachable. frappe.ping answers without credentials, so a pong does not prove the configured login works; any other tool call does.

Remove users' assignments of a document: their open ToDos are cancelled and they are notified. Users not assigned are reported in not_assigned. Returns unassigned, not_assigned and assignees.

Remove tags from a document (the match ignores case). Needs write permission on the document. Returns removed, not_tagged and tags.

Rename a document; links to it are updated. With merge=true it is merged into the existing document named new_name and disappears, which cannot be undone. Returns the new name.

Restore a deleted document from its "Deleted Document" record, the undo of delete_doc. Name the Deleted Document (deleted_document), or the deleted document (doctype and name: its latest unrestored deletion is used), not both. The DocType rules apply to the deleted document's own DocType, so a deleted Server Script, User or Webhook is refused unless allow_doctypes lists it. A DocType named by hash or naming series may get a new name. Returns restored, deleted_document and the restored name.

Execute a Frappe query report and return its columns and data rows. Strips execution metadata (timing, chart config). Includes report_summary if the report provides one. When rows are cut by limit, total_rows and truncated are included. Use list_reports first to discover available report names.

Show whether the site's scheduler is active, how many scheduled job types are enabled and stopped, and which ones failed within since, with their failure count and the last line of the last error (System Manager only; list_errors and list_jobs have whole tracebacks). Only job types with Create Log leave a log (Frappe sets it for every frequency but All and Cron); other failures show only in list_jobs status=failed.

Description is built at runtime.

Give a user, or every user, access to one document beyond what their roles allow. Read is always granted; write, submit (submittable DocTypes only) and share (may share further) add rights. Sharing again with the same user replaces that share's rights. The user may be asked to confirm. Returns the share's rights.

Read the site's System Health Report (System Manager only): background workers and queues, the scheduler and failing scheduled jobs, emails (7 days), errors (24 hours), database, cache, storage and users. attention lists what needs attention. Building it takes a few seconds and, as the desk's page does, queues one frappe.ping background job to test the queue; it changes nothing else. A check that failed on the site leaves its fields out.

Submit a draft document (docstatus 0 to 1), which makes it final: a submitted document can only be cancelled, not edited. Refused for DocTypes with an active Workflow (use apply_workflow). Returns the submitted document.

Remove a user's (or everyone's) share of a document. Access their roles give is not affected. Returns removed: false when there was no such share.

Update an existing Frappe document. Provide only the fields you want to change as a JSON object (a "name" key in data is ignored). Returns the full updated document. For Single DocTypes (e.g. 'System Settings'), omit name — the DocType name is used automatically.

Show which user the configured credentials belong to on the Frappe site, the user's roles, and the installed apps with their versions (Frappe major version included). Unlike ping this proves the login works. Versions are cached for 24 hours.