Skip to main content
Glama

configure_offline_sync

Idempotent

Configure mobile offline sync by setting a table's data item query condition, and optionally mark a screen available offline or enable offline on an app config.

Instructions

Configure which records of a table are available offline in mobile: sets the data item offline query condition, and optionally marks a screen available offline and enables offline on an app config. [Write]

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "table": "<table>"
    },
    "name": "configure_offline_sync"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryNoFilter query for sync scope (the data item offline query condition)
tableYesTable to sync offline
screenNoOptional screen (sys_sg_screen) sys_id to mark available offline
data_itemNoExisting data item (sys_sg_data_item) sys_id to configure; a new offline data item for the table is created if omitted
app_configNoOptional mobile app config (sys_sg_native_client) sys_id to enable offline on
max_recordsNoNot stored (mobile offline has no per-table record cap); kept for compatibility

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv5.0.1
    • addedInput schema / properties / app_config
      Added value: +{
      +  "description": "Optional mobile app config (sys_sg_native_client) sys_id to enable offline on",
      +  "type": "string"
      +}
    • addedInput schema / properties / data_item
      Added value: +{
      +  "description": "Existing data item (sys_sg_data_item) sys_id to configure; a new offline data item for the table is created if omitted",
      +  "type": "string"
      +}
    • changedInput schema / properties / max_records / description
      Previous value: -"Max offline records (default 500)"New value: +"Not stored (mobile offline has no per-table record cap); kept for compatibility"
    • changedInput schema / properties / query / description
      Previous value: -"Filter query for sync scope"New value: +"Filter query for sync scope (the data item offline query condition)"
    • addedInput schema / properties / screen
      Added value: +{
      +  "description": "Optional screen (sys_sg_screen) sys_id to mark available offline",
      +  "type": "string"
      +}
  2. First observedv1.0.2

TDQS

A3.6/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The annotations already disclose that this is a write operation, open-world, idempotent, and non-destructive. The description adds useful behavioral detail by saying it sets an offline query condition and can optionally mark a screen available offline and enable offline on an app config. It still omits permissions, return behavior, and what happens when existing offline configuration is changed.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single front-loaded sentence that states the main action, scope, and optional effects with no wasted wording. The trailing write marker is redundant with annotations but minimal and does not impair clarity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a six-parameter write configuration tool, the description covers the main effect and the optional screen and app-config outcomes. Because the input schema is fully described, the remaining details such as data_item creation and max_records being ignored are available there. The main missing piece is any explanation of the response or operational prerequisites.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all six parameters in detail. The description adds only high-level mapping for query, screen, and app_config, while table, data_item, and max_records are left to the schema. This meets the baseline for fully covered schemas.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb and resource: configuring which records of a table are available offline in mobile. It also names the core mechanism, the data item offline query condition, and optional screen/app-config actions. It does not explicitly differentiate from sibling tools, so it is clear but not maximally distinguished.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The mobile offline context implies when the tool is relevant, and the optional actions for screen and app config give some usage shape. However, there is no explicit when-to-use guidance, no exclusions, and no named alternatives for related configuration tasks.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools