Informat AI Agent Skill

What is SKILL.md

SKILL.md is the core instruction file for the Informat AI Skill, defining all platform system methods, invocation rules, and parameter specifications available to AI agents.

When an AI agent (such as Claude Code, OpenClaw, VSCode, etc.) loads the Informat Skill, it reads this file to understand:

• What it can do — 181 system methods covering data tables, automation, workflows, dashboards, scripts, and all other platform capabilities
• How to invoke — Method classification rules, parameter documentation locations, invocation steps
• Operational constraints — Mandatory safety rules (e.g., query before operating, never fabricate IDs)

Usage Scenario

You don't need to manually edit SKILL.md. It is distributed with the Skill package, and AI agents will automatically read and follow its rules. If you want to understand why the AI agent performs certain steps (e.g., querying existing tables before creating new ones), refer to the "Invocation Rules" and "Query Before Any Operation" sections in this document.

Skill project open source repository: informat365/informat-skills

Method Overview

181 methods in total. Parameter definition files for each method are located under {baseDir}/references/.

📚 Reference Documentation Directory: {baseDir}/references/doc/ contains complete platform development documentation:

• references/doc/markdown/ directory: Official documentation for core platform features (AI assistant, API, automation, dashboards, expressions, scheduled tasks, scripts, data tables, tasks, websites, etc.)
• references/doc/script/ directory: Script API reference documentation, organized by module (bpmn.md, table.md, form.md, etc.) — consult these first when developing scripts

Invocation Rules

The system automatically selects the corresponding agent interface based on the method name prefix:

Prefix	Interface Type	Required Parameters
_wb_	Workbench Agent	None
_company_	Team Agent	None
Common methods	Common Agent	None
Others	App Agent	--appId

How to Invoke

# Step 1: Read parameter documentation (required for methods with parameters)
cat {baseDir}/references/system_query_table_define.json

# Step 2: Write parameter file
echo '{"tableId":"myTable"}' > params.json

# Step 3: Execute
# App method (requires --appId)
node {baseDir}/scripts/call_informat.js _query_table_define --appId <appId> --file params.json

# Common method (no --appId needed)
node {baseDir}/scripts/call_informat.js _get_current_time

# Team method (no --appId needed)
node {baseDir}/scripts/call_informat.js _company_app_list

# Workbench method (no --appId needed)
node {baseDir}/scripts/call_informat.js _wb_get_login_info

Getting the App ID

# 1. Query all app list
node {baseDir}/scripts/call_informat.js _company_app_list

# 2. Find the target app ID from the results for subsequent calls
node {baseDir}/scripts/call_informat.js _query_app_define_designer --appId <appId>

Configuration

Two methods are supported, with system environment variables taking priority over .env files:

# Method 1: System environment variables (priority)
export INFORMAT_HOST=<informat host>
export INFORMAT_AGENT_TOKEN=<informat host>

# Method 2: Edit {baseDir}/scripts/.env
INFORMAT_HOST=<informat host>
INFORMAT_AGENT_TOKEN=<your-agent-token>

To obtain INFORMAT_AGENT_TOKEN: After logging in, visit https://{hostname}/workbench/account/aiAgentApiKey

Query Before Any Operation — The Most Important Rule

Before executing any create or modify operation, you must first query the existing system structure to obtain real IDs. Fabricating any IDs or field names is strictly prohibited.

Querying the list alone is not sufficient — you must further query the complete field structure of each related table. This is because creating relation fields requires the target table's field IDs; knowing only the table ID is not enough.

Before Creating an App

1. _company_app_list          -> Get all existing apps, including unique app identifiers

Before Creating Data Tables

1. _query_table_list_designer          -> Get all existing tables and their IDs
2. For each table that may be referenced, call
   _query_table_define_designer        -> Get the complete field list (field IDs, field types, option values, etc.)
   This step cannot be skipped because relation fields require the target table's field IDs
3. cat {baseDir}/references/system_create_table_module.json  -> Read parameter documentation
4. Use the queried real table IDs and field IDs to construct parameters for creating new tables

Why you must query each table's field structure:

• RelationRecord fields require tableId (target table ID) and nameFieldId (field ID used for display in the target table)
• RelationRecordField fields require fieldId (foreign key field ID in current table), targetTableId, targetFieldId
• LookupList fields require subtable ID and the foreign key field ID in the subtable
• LookupRollup fields require subtable ID and the aggregation field ID in the subtable
• These IDs can only be obtained by querying with _query_table_define_designer

Before Creating Dashboard Cards

1. _query_table_list_designer          -> Get all table IDs
2. For the target data source table, call
   _query_table_define_designer        -> Get all field IDs and field types
   Without querying the field structure, you cannot correctly configure aggregation fields, grouping fields, or filter conditions
3. _read_informat_dashboard_document   -> Get dashboard documentation
4. cat {baseDir}/references/system_save_dashboard_prochart_card.json
   or system_save_dashboard_number_card.json  -> Read parameter documentation
5. Use the queried real field IDs to construct card parameters

Before Creating Automations

1. _query_app_define_designer          -> Get module list, existing automation groups
2. _query_table_list_designer          -> Get all table IDs
3. For each table involved in the automation, call
   _query_table_define_designer        -> Get field IDs (field mappings and filter conditions in automation steps require real field IDs)
4. _automatic_doc                      -> Get automation documentation
5. cat {baseDir}/references/system_automatic_save_define.json  -> Read parameter documentation
6. Use the queried real IDs to construct automation steps

Before Creating Workflows

1. _query_app_define_designer -> Get module list
2. _query_table_list_designer + _query_table_define_designer -> Get tables and fields
3. _read_informat_expression_doc -> Get expression documentation (workflows extensively use expressions)
4. Read the corresponding parameter documentation
5. Create in order: Module -> Process Definition -> Start Configuration -> Nodes -> Flow Lines

Before Creating Scripts

1. _query_informat_script_list -> Get existing scripts and directories
2. _read_informat_script_sdk -> Get script SDK documentation
3. Consult the script documentation under {baseDir}/references/doc/script/ for the relevant module (e.g., bpmn.md, table.md, etc.) to understand API usage specifications
4. Create a directory first if needed: _create_informat_script_directory
5. Read cat {baseDir}/references/system_save_informat_script.json
6. Create or edit scripts (when editing, you must pass the existing script ID — do not create duplicates)

Before Editing Fields

1. _query_table_list_designer -> Find the target table
2. _query_table_define_designer -> Get the complete field list for that table
3. _read_informat_expression_doc -> If expressions need to be configured
4. Read cat {baseDir}/references/system_edit_table_field.json
5. Operate using the real tableId and fieldId

Before Operating Data Records

1. _query_all_table_list -> Get published table IDs
2. _query_table_define -> Get published field structure
3. Read the corresponding parameter documentation
4. Use real field IDs to construct record data

Workbench Agent Method List

Scope	Method Name	Description	Parameter Documentation
[User]	_wb_set_curr_appid	Set the app ID for the current session context	references/system_wb_set_curr_appid.json MUST READ
[User]	_wb_process_define_list	Get the list of workflows the current user can initiate	references/system_wb_process_define_list.json MUST READ
[User]	_wb_get_process_define	Get the configuration of a specified workflow process definition	references/system_wb_get_process_define.json MUST READ
[User]	_wb_get_table_info	Get the structure information of a specified data table	references/system_wb_get_table_info.json MUST READ
[User]	_wb_get_login_info	Get my login information including user info and system configuration	none
[User]	_wb_create_instance	Create and start a workflow process instance	references/system_wb_create_instance.json MUST READ
[User]	_wb_query_instance_list	Query all process instances initiated by the current user (cross-app)	references/system_wb_query_instance_list.json MUST READ
[User]	_wb_query_instance_info	Query workbench process instance details	references/system_wb_query_instance_info.json MUST READ
[User]	_wb_query_task_list	Query workbench workflow task list (cross-app)	references/system_wb_query_task_list.json MUST READ
[User]	_wb_query_task_info	Query workbench workflow task details	references/system_wb_query_task_info.json MUST READ
[User]	_wb_complete_task	Complete (approve) a workbench workflow task	references/system_wb_complete_task.json MUST READ
[User]	_wb_ask_ai	Ask the AI assistant a question	references/system_wb_ask_ai.json MUST READ

Team Agent Method List

Scope	Method Name	Description	Parameter Documentation
[Team]	_company_app_list	Query app list	references/system_company_app_list.json MUST READ
[Team]	_company_app_create	Create an app	references/system_company_app_create.json MUST READ
[Team]	_company_app_update	Update team app information (name, group, etc.)	references/system_company_app_update.json MUST READ
[Team]	_company_app_group_list	Get app group list	references/system_company_app_group_list.json MUST READ
[Team]	_company_app_group_create	Create an app group	references/system_company_app_group_create.json MUST READ
[Team]	_company_app_group_update	Update an app group	references/system_company_app_group_update.json MUST READ
[Team]	_company_app_group_delete	Delete an app group (dangerous operation)	references/system_company_app_group_delete.json MUST READ
[Team]	_company_department_list	Get team department list	references/system_company_department_list.json MUST READ
[Team]	_company_department_create	Create a new department in the company	references/system_company_department_create.json MUST READ
[Team]	_company_department_update	Update an existing department in the company	references/system_company_department_update.json MUST READ
[Team]	_company_department_delete	Delete an existing department in the company (dangerous operation)	references/system_company_department_delete.json MUST READ
[Team]	_company_role_list	Query role list	references/system_company_role_list.json MUST READ
[Team]	_company_role_create	Create a new role in the company	references/system_company_role_create.json MUST READ
[Team]	_company_role_update	Update an existing role in the company	references/system_company_role_update.json MUST READ
[Team]	_company_role_delete	Delete an existing role in the company (dangerous operation)	references/system_company_role_delete.json MUST READ
[Team]	_company_role_permission_list	Query the list of role permissions supported by the team	none
[Team]	_company_member_list	Query team member list	references/system_company_member_list.json MUST READ
[Team]	_company_member_list_count	Get total number of company members	references/system_company_member_list_count.json MUST READ
[Team]	_company_member_create	Add an existing account as a team member	references/system_company_member_create.json MUST READ
[Team]	_company_member_create_new	Create a new account and add as a team member	references/system_company_member_create_new.json MUST READ
[Team]	_company_member_update	Edit a team member	references/system_company_member_update.json MUST READ
[Team]	_company_member_delete	Delete a team member (dangerous operation)	references/system_company_member_delete.json MUST READ
[Team]	_company_member_info	Query team member details	references/system_company_member_info.json MUST READ
[Team]	_company_get_ai_model_list	Get team AI model list	none

App Agent Method List

[App Designer] = Draft environment. [User] = Published environment.

API (Designer)

Scope	Method Name	Description	Parameter Documentation
[App Designer]	_api_create_define	Create API definition	references/system_api_create_define.json MUST READ
[App Designer]	_api_delete_define	Delete API definition (dangerous operation)	references/system_api_delete_define.json MUST READ
[App Designer]	_api_doc	Query Informat API documentation	none
[App Designer]	_api_query_define_designer	Query a single API detailed definition	references/system_api_query_define_designer.json MUST READ
[App Designer]	_api_query_define_list	Query API definition list under the app	none
[App Designer]	_api_update_define	Update API definition, updateFieldList declares which fields to modify	references/system_api_update_define.json MUST READ

App (Designer)

Scope	Method Name	Description	Parameter Documentation
[App Designer]	_app_check_setting	Validate draft configuration before publishing	none
[App Designer]	_app_create_role	Create an app role	references/system_app_create_role.json MUST READ
[App Designer]	_app_delete_draft_define	Delete draft version Define (irreversible)	references/system_app_delete_draft_define.json MUST READ
[App Designer]	_app_get_define_list	Get app definition object list	references/system_app_get_define_list.json MUST READ
[App Designer]	_app_get_define_object	Get a single definition object details	references/system_app_get_define_object.json MUST READ
[App Designer]	_app_get_define_type	Get supported definition object types	none
[App Designer]	_app_get_draft_define_count	Draft change count statistics	none
[App Designer]	_app_get_draft_define_list	Draft object list	none
[App Designer]	_app_publish	Publish app to production (AI should not call this — remind user to operate manually)	references/system_app_publish.json MUST READ
[App Designer]	_app_save_define_object	Save definition object structure	references/system_app_save_define_object.json MUST READ
[App Designer]	_app_set_themestyle	Set app theme style (query _app_themestyle_doc first)	references/system_app_set_themestyle.json MUST READ
[App Designer]	_app_themestyle_doc	Query app theme style documentation	none
[App Designer]	_query_app_define_designer	Query app designer configuration (module list, roles, APIs, automation groups, etc.)	none
[App Designer]	_create_module_group	Create module group	references/system_create_module_group.json MUST READ
[App Designer]	_update_module_and_group_order	Update module order	references/system_update_module_and_group_order.json MUST READ

Data Table (Designer)

Scope	Method Name	Description	Parameter Documentation
[App Designer]	_create_table_module	Create data table (must query existing tables and field structures first)	references/system_create_table_module.json MUST READ
[App Designer]	_create_table_field_group	Create data table field group	references/system_create_table_field_group.json MUST READ
[App Designer]	_table_save_filter_condition	Set data table view filter conditions	references/system_table_save_filter_condition.json MUST READ
[App Designer]	_table_save_datasource_dbview	Save database view data table SQL configuration	references/system_table_save_datasource_dbview.json MUST READ
[App Designer]	_table_create_tool_bar_button	Create data table toolbar button (supports calling scripts or automations)	references/system_table_create_tool_bar_button.json MUST READ
[App Designer]	_table_list_tool_bar_button	Query data table toolbar button list	references/system_table_list_tool_bar_button.json MUST READ
[App Designer]	_table_update_tool_bar_button	Update data table toolbar button	references/system_table_update_tool_bar_button.json MUST READ
[App Designer]	_table_delete_tool_bar_button	Delete data table toolbar button	references/system_table_delete_tool_bar_button.json MUST READ
[App Designer]	_table_create_form_tool_bar_btn	Create data table form toolbar button (supports calling scripts or automations)	references/system_table_create_form_tool_bar_btn.json MUST READ
[App Designer]	_table_list_form_tool_bar_btn	Query data table form toolbar button list	references/system_table_list_form_tool_bar_btn.json MUST READ
[App Designer]	_table_update_form_tool_bar_btn	Update data table form toolbar button	references/system_table_update_form_tool_bar_btn.json MUST READ
[App Designer]	_table_del_form_tool_bar_btn	Delete data table form toolbar button	references/system_table_del_form_tool_bar_btn.json MUST READ
[App Designer]	_subtable_create_tool_bar_btn	Create subtable toolbar button (for relation list/lookup list fields only, supports add row, delete, call scripts or automations)	references/system_subtable_create_tool_bar_btn.json MUST READ
[App Designer]	_subtable_list_tool_bar_btn	Query subtable toolbar button list	references/system_subtable_list_tool_bar_btn.json MUST READ
[App Designer]	_subtable_update_tool_bar_btn	Update subtable toolbar button	references/system_subtable_update_tool_bar_btn.json MUST READ
[App Designer]	_subtable_delete_tool_bar_btn	Delete subtable toolbar button	references/system_subtable_delete_tool_bar_btn.json MUST READ
[App Designer]	_query_table_list_designer	Query all tables in app designer (including unpublished, does not return field structures)	none
[App Designer]	_query_table_define_designer	Query data table field structure in app designer	references/system_query_table_define_designer.json MUST READ
[App Designer]	_query_table_field_designer	Query a single field's detailed configuration	references/system_query_table_field_designer.json MUST READ
[App Designer]	_edit_table_field	Edit field (must query table structure to get real IDs first)	references/system_edit_table_field.json MUST READ
[App Designer]	_edit_table_module	Modify data table module information	references/system_edit_table_module.json MUST READ

Workflow - BPMN (Designer)

Scope	Method Name	Description	Parameter Documentation
[App Designer]	_bpmn_create_module	Create workflow module	references/system_bpmn_create_module.json MUST READ
[App Designer]	_bpmn_create_process_define	Create process definition	references/system_bpmn_create_process_define.json MUST READ
[App Designer]	_bpmn_update_start_setting	Update process start configuration	references/system_bpmn_update_start_setting.json MUST READ
[App Designer]	_bpmn_create_or_update_node	Create/update process node	references/system_bpmn_create_or_update_node.json MUST READ
[App Designer]	_bpmn_create_or_update_flow	Create/update flow line	references/system_bpmn_create_or_update_flow.json MUST READ
[App Designer]	_bpmn_delete_node	Delete process node	references/system_bpmn_delete_node.json MUST READ
[App Designer]	_bpmn_delete_flow	Delete flow line	references/system_bpmn_delete_flow.json MUST READ
[App Designer]	_bpmn_query_process_define	Query process definition details	references/system_bpmn_query_process_define.json MUST READ
[App Designer]	_bpmn_query_process_define_list	Query process definition list under a module	references/system_bpmn_query_process_define_list.json MUST READ

Automation (Designer)

Scope	Method Name	Description	Parameter Documentation
[App Designer]	_automatic_create_group	Create automation group (query _query_app_define_designer first to avoid duplicates)	references/system_automatic_create_group.json MUST READ
[App Designer]	_automatic_delete_group	Delete automation group	references/system_automatic_delete_group.json MUST READ
[App Designer]	_automatic_update_group	Edit automation group	references/system_automatic_update_group.json MUST READ
[App Designer]	_automatic_save_define	Save automation configuration (must query table structure to get field IDs first)	references/system_automatic_save_define.json MUST READ
[App Designer]	_automatic_query_define	Query automation configuration	references/system_automatic_query_define.json MUST READ
[App Designer]	_automatic_run_once	Execute automation immediately (high risk — confirm first)	references/system_automatic_run_once.json MUST READ
[App Designer]	_automatic_doc	Read automation documentation	none

Dashboard (Designer)

Scope	Method Name	Description	Parameter Documentation
[App Designer]	_create_dashboard_module	Create dashboard module	references/system_create_dashboard_module.json MUST READ
[App Designer]	_query_dashboard_list_designer	Query all dashboards	none
[App Designer]	_query_dashboard_card_list	Query dashboard card list	references/system_query_dashboard_card_list.json MUST READ
[App Designer]	_query_dashboard_card_detail	Query card details	references/system_query_dashboard_card_detail.json MUST READ
[App Designer]	_save_dashboard_number_card	Create/edit number card (query table structure to get field IDs first)	references/system_save_dashboard_number_card.json MUST READ
[App Designer]	_save_dashboard_prochart_card	Create/edit chart card (query table structure to get field IDs first)	references/system_save_dashboard_prochart_card.json MUST READ

Script (Designer)

Scope	Method Name	Description	Parameter Documentation
[App Designer]	_create_informat_script_directory	Create script directory	references/system_create_informat_script_directory.json MUST READ
[App Designer]	_save_informat_script	Save script (must pass existing ID when editing)	references/system_save_informat_script.json MUST READ
[App Designer]	_query_informat_script_list	Query script list	none
[App Designer]	_query_informat_script_content	Query script content	references/system_query_informat_script_content.json MUST READ
[App Designer]	_execute_informat_script_designer	Execute script in designer	references/system_execute_informat_script_designer.json MUST READ
[App Designer]	_script_save_git_config	Save script Git repository configuration	references/system_script_save_git_config.json MUST READ
[App Designer]	_script_pull_from_git	Pull scripts from Git repository to app	references/system_script_pull_from_git.json MUST READ
[App Designer]	_script_push_to_git	Push app scripts to Git repository	references/system_script_push_to_git.json MUST READ

Scheduled Tasks (Designer)

Scope	Method Name	Description	Parameter Documentation
[App Designer]	_schedule_create_define	Create scheduled task	references/system_schedule_create_define.json MUST READ
[App Designer]	_schedule_update_define	Update scheduled task	references/system_schedule_update_define.json MUST READ
[App Designer]	_schedule_delete_define	Delete scheduled task	references/system_schedule_delete_define.json MUST READ
[App Designer]	_schedule_query_define_designer	Query scheduled task details	references/system_schedule_query_define_designer.json MUST READ
[App Designer]	_schedule_query_define_list	Query scheduled task list	none
[App Designer]	_schedule_run_once	Trigger once immediately	references/system_schedule_run_once.json MUST READ
[App Designer]	_schedule_doc	Query scheduled task documentation	none

Internationalization - I18n (Designer)

Scope	Method Name	Description	Parameter Documentation
[App Designer]	_i18n_query_define_designer	Query internationalization configuration	none
[App Designer]	_i18n_save_define_designer	Save translation definitions	references/system_i18n_save_define_designer.json MUST READ
[App Designer]	_i18n_save_locale_designer	Save language list	references/system_i18n_save_locale_designer.json MUST READ
[App Designer]	_i18n_set_app_name	Set app internationalized name	references/system_i18n_set_app_name.json MUST READ
[App Designer]	_i18n_set_module_name	Set module internationalized name	references/system_i18n_set_module_name.json MUST READ
[App Designer]	_i18n_set_table_field_name	Set field internationalized name	references/system_i18n_set_table_field_name.json MUST READ
[App Designer]	_i18n_set_field_option_name	Set option value internationalized name	references/system_i18n_set_field_option_name.json MUST READ

Website Resources (Designer)

Scope	Method Name	Description	Parameter Documentation
[App Designer]	_website_create_module	Create website module (query first to avoid duplicates)	references/system_website_create_module.json MUST READ
[App Designer]	_website_create_directory	Create resource directory	references/system_website_create_directory.json MUST READ
[App Designer]	_website_save_resource	Create/edit resource (query ID first when editing)	references/system_website_save_resource.json MUST READ
[App Designer]	_website_delete_resource	Delete resource	references/system_website_delete_resource.json MUST READ
[App Designer]	_website_query_define_designer	Query website module details	references/system_website_query_define_designer.json MUST READ
[App Designer]	_website_query_list_designer	Query all website modules	none
[App Designer]	_website_query_resource	Query resource details	references/system_website_query_resource.json MUST READ
[App Designer]	_website_preview	Preview website	references/system_website_preview.json MUST READ
[App Designer]	_website_read_informat_doc	Read website designer documentation	none

AI Assistant (Designer)

Scope	Method Name	Description	Parameter Documentation
[App Designer]	_aiassistant_create	Create AI assistant module	references/system_aiassistant_create.json MUST READ
[App Designer]	_aiassistant_update	Update AI assistant module	references/system_aiassistant_update.json MUST READ
[App Designer]	_aiassistant_delete	Delete AI assistant module	references/system_aiassistant_delete.json MUST READ
[App Designer]	_aiassistant_doc	Query AI assistant documentation	none

Listener - AppListener (Designer)

Scope	Method Name	Description	Parameter Documentation
[App Designer]	_app_listener_create	Create a new listener definition	references/system_app_listener_create.json MUST READ
[App Designer]	_app_listener_update	Update listener definition, updateFieldList declares which fields to modify	references/system_app_listener_update.json MUST READ
[App Designer]	_app_listener_delete	Delete listener definition (if it's a directory, all listeners under it will also be deleted)	references/system_app_listener_delete.json MUST READ
[App Designer]	_app_listener_list	Query listener definition list under the current app (tree structure, includes directories and child listeners)	references/system_app_listener_list.json MUST READ

Survey (Designer)

Scope	Method Name	Description	Parameter Documentation
[App Designer]	_survey_create_module	Create survey module	references/system_survey_create_module.json MUST READ
[App Designer]	_survey_create_item	Create survey question	references/system_survey_create_item.json MUST READ
[App Designer]	_survey_update_item	Update survey question	references/system_survey_update_item.json MUST READ
[App Designer]	_survey_delete_item	Delete survey question	references/system_survey_delete_item.json MUST READ
[App Designer]	_survey_query_define_designer	Query survey configuration	references/system_survey_query_define_designer.json MUST READ

App (User)

Scope	Method Name	Description	Parameter Documentation
[User]	_query_app_define	Query published app configuration (module list, roles, APIs, etc.)	none
[User]	_query_app_user	Query current user's role permissions in this app (admins have all permissions and don't return permissionList; non-admins return permission list in moduleKey_permissionName format)	none
[User]	_query_app_user_list	Query account information (ID, email, supervisor, department)	references/system_query_app_user_list.json MUST READ
[User]	_app_member_create	Add an existing team member to the current app	references/system_app_member_create.json MUST READ
[User]	_app_member_update	Update app member role information	references/system_app_member_update.json MUST READ
[User]	_app_member_delete	Remove a member from the current app (dangerous operation)	references/system_app_member_delete.json MUST READ

Data Table (User)

Scope	Method Name	Description	Parameter Documentation
[User]	_query_all_table_list	Query all published data tables (does not return field structures)	none
[User]	_query_table_define	Query published table field structure (for record operations)	references/system_query_table_define.json MUST READ
[User]	_query_table_record_list	Query data table records by conditions	references/system_query_table_record_list.json MUST READ
[User]	_query_table_record_list_count	Count records matching conditions	references/system_query_table_record_list_count.json MUST READ
[User]	_table_record_batch_insert	Batch insert records (query table structure to get field IDs first)	references/system_table_record_batch_insert.json MUST READ
[User]	_table_record_batch_update	Batch update records	references/system_table_record_batch_update.json MUST READ
[User]	_table_record_batch_delete	Batch delete records (dangerous operation)	references/system_table_record_batch_delete.json MUST READ

Workflow - BPMN (User)

Scope	Method Name	Description	Parameter Documentation
[User]	_bpmn_create_instance	Create and start a workflow process instance (query process definition first)	references/system_bpmn_create_instance.json MUST READ
[User]	_bpmn_query_instance_list	Query process instance list initiated by the current user	references/system_bpmn_query_instance_list.json MUST READ
[User]	_bpmn_query_instance_info	Query process instance details	references/system_bpmn_query_instance_info.json MUST READ
[User]	_bpmn_query_task_list	Query workflow task list assigned to the current user	references/system_bpmn_query_task_list.json MUST READ
[User]	_bpmn_query_task_info	Query workflow task details	references/system_bpmn_query_task_info.json MUST READ
[User]	_bpmn_complete_task	Complete (approve) a workflow task	references/system_bpmn_complete_task.json MUST READ
[User]	_bpmn_process_define_list	Get process definition list	references/system_bpmn_process_define_list.json MUST READ
[User]	_bpmn_get_process_define	Get process definition details	references/system_bpmn_get_process_define.json MUST READ

Search Engine - Textindex (User)

Scope	Method Name	Description	Parameter Documentation
[User]	_query_all_textindex_list	Query search engine module list	none
[User]	_textindex_search	Search engine keyword search	references/system_textindex_search.json MUST READ

Knowledge Base (User)

Scope	Method Name	Description	Parameter Documentation
[User]	_knowledgebase_search	Knowledge base keyword search	references/system_knowledgebase_search.json MUST READ

Common Agent Method List

The following methods do not require --appId and can be called directly.

Scope	Method Name	Description	Parameter Documentation
[Common]	_app_get_web_url	Get app web root URL	none
[Common]	_app_doc	Query app documentation	none
[Common]	_javascript_eval	Execute JavaScript code	references/system_javascript_eval.json MUST READ
[Common]	_render_html	Render HTML content	references/system_render_html.json MUST READ
[Common]	_web_content	Get web URL content	references/system_web_content.json MUST READ
[Common]	_get_current_time	Get current time	none
[Common]	_get_current_user	Get current user	none
[Common]	_read_informat_expression_doc	Informat expression documentation	none
[Common]	_read_informat_script_sdk	Informat script SDK documentation	none
[Common]	_read_informat_dashboard_document	Informat dashboard chart documentation	none
[Common]	_list_informat_markdown	List all available Markdown documents	none
[Common]	_read_informat_markdown	Read specified Markdown document content (supports subdirectories like script/)	references/system_read_informat_markdown.json MUST READ
[Common]	_read_office_file	Read Office document content	references/system_read_office_file.json MUST READ
[Common]	_send_notification	Send notification	references/system_send_notification.json MUST READ
[Common]	_send_system_email	Send email	references/system_send_system_email.json MUST READ

Local Reference Documentation

No API calls needed — consult the {baseDir}/references/doc/ directory directly:

Core Feature Documentation (doc/markdown/ directory):

Document Filename	Description
informat.aiassistant.md	AI Assistant development documentation
informat.api.md	Open API documentation
informat.app.md	App documentation
informat.app.themestyle.md	App theme style documentation
informat.automatic.md	Automation workflow documentation
informat.company.md	Team documentation (team members, team roles, organizational structure)
informat.dashboard.md	Dashboard development documentation
informat.expression.md	Expression syntax documentation
informat.schedule.md	Scheduled task documentation
informat.script.md	Script development overview
informat.table.md	Data table design documentation
informat.task.md	Task center documentation
informat.website.md	Website designer documentation

Script API Documentation (doc/script/ directory): Organized by module (bpmn.md, table.md, form.md, etc.), containing method descriptions, parameter definitions, and example code.

FAQ

Q: App module identifier already exists? That module ID is already in use — you need to use a different one.

Q: How to get an app's module list? Use _query_app_define_designer.

Q: What is the app's access URL? {host}/app/{appId}