Docyrus Architect

Guide for using

docyrus-architect

MCP tools to manage and query data sources in Docyrus.

Tool Overview

Discovery Tools

```
get_apps
```
— List tenant apps. Use before
```
create_data_source
```
to find the target
```
tenantAppId
```
.
```
get_data_source_list
```
— Search data sources by name/description or app ID.
```
get_data_source_list_with_fields
```
— Same as above but includes field names and types.
```
get_data_source_metadata
```
— Get full metadata (fields with IDs, types, slugs, enums, relations) for a data source. Always call this before querying to discover field slugs and relation targets.
```
get_enums_by_field_id
```
— Get enum options for select/status/tagSelect fields.
```
read_current_user
```
/
```
read_tenant_user
```
— Get user info.

Data Source CRUD

create_data_source

— Create a new data source (table). Default fields auto-created:

id

autonumber_id

name

record_owner

created_on

created_by

last_modified_by

last_modified_on

```
update_data_source
```
— Update data source properties.
```
delete_data_source
```
— Delete a data source and all its data.

Field Management

create_fields

— Batch create fields. Set

relationDataSourceId

for

field-relation

types.

```
update_fields
```
— Batch update fields. Non-CUSTOM fields get customization records.
```
delete_fields
```
— Batch delete fields by ID.

Enum Management

```
create_enums
```
— Create enum options for select/tagSelect/status fields. Pass
```
fieldId
```
for field-specific enums or
```
enumSetId
```
for shared enum sets.
```
update_enums
```
— Update enum option name/slug/color/icon.
```
delete_enums
```
— Delete enum options.

Query & Compute

```
query_data_source
```
— Read data with filtering, sorting, aggregation, formulas, pivots, child queries. See references/data-source-query-guide.md for complete query syntax.
```
evaluate_jsonata
```
— Test JSONata expressions. Use for validating computed field formulas.

Common Workflows

Create a Data Source with Fields and Enums

Call
```
get_apps
```
to find the target app ID
Call
```
create_data_source
```
with title (plural), name (singular), slug (singular snake_case)
Call
```
create_fields
```
with all custom fields (default fields already exist)
For select/tagSelect/status fields, call
```
create_enums
```
with the field ID from step 3

Query Data

Call
```
get_data_source_metadata
```
to discover field slugs, types, and relations
Call
```
query_data_source
```
with appropriate columns, filters, and sorting
For advanced queries (aggregations, formulas, pivots, child queries), read references/data-source-query-guide.md

Modify Existing Data Source

Call
```
get_data_source_metadata
```
to see current fields
Use
```
create_fields
```
/
```
update_fields
```
/
```
delete_fields
```
as needed

For enum changes, use

get_enums_by_field_id

first, then

create_enums

update_enums

delete_enums

Key Rules

Data Source Creation

```
title
```
is plural (e.g., "Sales Orders"),
```
name
```
is singular (e.g., "Sales Order"),
```
slug
```
is singular snake_case (e.g., "sales_order")
Use
```
defaultEditFormTarget: "tab"
```
for complex forms,
```
"side"
```
for simple ones
Enable
```
pluginActivityView
```
for CRM-type data sources (leads, contacts, deals)
Enable
```
pluginComments
```
for collaborative data sources
Enable
```
pluginFile
```
when users need to attach files to records
Enable
```
pluginDocyment
```
when users need rich text documents per record

Field Types

```
field-relation
```
requires
```
relationDataSourceId
```
— the ID of the related data source
```
field-list
```
is a virtual field showing child records (one-to-many) — not stored in DB
```
field-select
```
/
```
field-tagSelect
```
/
```
field-status
```
need enum options created after the field
```
field-formula
```
uses JSONata expressions — test with
```
evaluate_jsonata
```
first
```
field-inlineData
```
stores array of objects,
```
field-inlineForm
```
stores single nested object
Field
```
slug
```
must be snake_case matching
```
^[a-z][a-z0-9_]*$
```

Querying

Use
```
dataSourceId
```
(UUID) to identify which data source to query
```
columns
```
is a comma-separated string of field slugs, not an array
For aggregations, always use
```
id
```
field for
```
count
```
calculations
Relation expansion:
```
relation_field(sub_field1, sub_field2)
```
selects nested columns
Spread operator:
```
...relation_field(alias:sub_field)
```
flattens into root object
Filter on related fields:
```
rel_{{relation_slug}}/{{field_slug}}
```
Date filters have shortcut operators like
```
today
```
,
```
this_month
```
,
```
last_30_days
```

query_data_source Required Parameters

All parameters are required in the MCP tool schema (most accept

null

```
dataSourceId
```
: string (required, non-null)
```
columns
```
: string | null
```
filters
```
: object | null
```
filterKeyword
```
: string | null
```
orderBy
```
: array | null
```
limit
```
: number | null (default: 1000)
```
offset
```
: number | null
```
fullCount
```
: boolean | null
```
recordId
```
: string | null (fetch single record by ID)
```
calculations
```
: array | null
```
distinctColumns
```
: array | null
```
formulas
```
: array | null
```
childQueries
```
: array | null
```
pivot
```
: object | null

References

Data Source Query Guide — Complete reference for
```
query_data_source
```
including columns, filters, aggregations, formulas (simple + block AST), pivots, child queries, and full operator reference. Read this when building complex queries.
Formula Reference — Compact reference for SQL block formulas (inline and subquery). Read this when working with computed formula columns in queries.

docyrus-architect

NPX Install

Tags

SKILL.md Content