@lowdefy/docs-content 0.0.0-experimental-20260710073520
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +20 -0
- package/content/actions/callapi.md +66 -0
- package/content/actions/callmethod.md +41 -0
- package/content/actions/copytoclipboard.md +32 -0
- package/content/actions/displaymessage.md +53 -0
- package/content/actions/downloadcsv.md +89 -0
- package/content/actions/fetch.md +50 -0
- package/content/actions/geolocationcurrentposition.md +56 -0
- package/content/actions/link.md +104 -0
- package/content/actions/login.md +85 -0
- package/content/actions/logout.md +56 -0
- package/content/actions/pdfmake.md +304 -0
- package/content/actions/request.md +67 -0
- package/content/actions/reset.md +27 -0
- package/content/actions/resetvalidation.md +85 -0
- package/content/actions/scrollto.md +85 -0
- package/content/actions/setdarkmode.md +62 -0
- package/content/actions/setfocus.md +33 -0
- package/content/actions/setglobal.md +63 -0
- package/content/actions/setlocale.md +69 -0
- package/content/actions/setstate.md +70 -0
- package/content/actions/throw.md +72 -0
- package/content/actions/validate.md +87 -0
- package/content/actions/wait.md +24 -0
- package/content/agents/agent-endpoint-tools.md +190 -0
- package/content/agents/agent-mcp-tools.md +124 -0
- package/content/agents/agent-multi-agent.md +136 -0
- package/content/agents/agent-properties.md +174 -0
- package/content/agents/agent-server-hooks.md +336 -0
- package/content/agents/agentchat.md +515 -0
- package/content/agents/agentconversations.md +148 -0
- package/content/concepts/ai-agent-docs.md +190 -0
- package/content/concepts/cli.md +213 -0
- package/content/concepts/connections-and-requests.md +7 -0
- package/content/concepts/custom-html.md +3 -0
- package/content/concepts/custom-styling.md +161 -0
- package/content/concepts/events-and-actions.md +271 -0
- package/content/concepts/hosting-files.md +18 -0
- package/content/concepts/i18n.md +320 -0
- package/content/concepts/keyboard-shortcuts.md +218 -0
- package/content/concepts/layout-overview.md +478 -0
- package/content/concepts/lists.md +144 -0
- package/content/concepts/logger.md +43 -0
- package/content/concepts/lowdefy-schema.md +365 -0
- package/content/concepts/menus.md +144 -0
- package/content/concepts/module-authoring.md +564 -0
- package/content/concepts/modules.md +338 -0
- package/content/concepts/operators.md +45 -0
- package/content/concepts/overview.md +19 -0
- package/content/concepts/references-and-templates.md +207 -0
- package/content/concepts/secrets.md +24 -0
- package/content/concepts/selectors.md +143 -0
- package/content/connections/amazonredshift.md +176 -0
- package/content/connections/anthropic.md +232 -0
- package/content/connections/awss3.md +313 -0
- package/content/connections/azureblobstorage.md +133 -0
- package/content/connections/elasticsearch.md +371 -0
- package/content/connections/google.md +228 -0
- package/content/connections/googlecloudstorage.md +139 -0
- package/content/connections/googlesheet.md +313 -0
- package/content/connections/knex.md +206 -0
- package/content/connections/mariadb.md +177 -0
- package/content/connections/mcp.md +134 -0
- package/content/connections/mongodb.md +739 -0
- package/content/connections/mssql.md +191 -0
- package/content/connections/mysql.md +192 -0
- package/content/connections/openai-connection.md +228 -0
- package/content/connections/postgresql.md +200 -0
- package/content/connections/redis.md +116 -0
- package/content/connections/sendgridmail.md +94 -0
- package/content/connections/smtp.md +149 -0
- package/content/connections/sqlite.md +187 -0
- package/content/connections/stripe.md +115 -0
- package/content/container-blocks/affix.md +413 -0
- package/content/container-blocks/alert.md +937 -0
- package/content/container-blocks/badge.md +1222 -0
- package/content/container-blocks/box.md +1453 -0
- package/content/container-blocks/card.md +1200 -0
- package/content/container-blocks/carousel.md +2247 -0
- package/content/container-blocks/collapse.md +1335 -0
- package/content/container-blocks/configprovider.md +1070 -0
- package/content/container-blocks/confirmmodal.md +1159 -0
- package/content/container-blocks/content.md +597 -0
- package/content/container-blocks/descriptions.md +870 -0
- package/content/container-blocks/drawer.md +1379 -0
- package/content/container-blocks/dropdownmenu.md +643 -0
- package/content/container-blocks/flex.md +1510 -0
- package/content/container-blocks/footer.md +380 -0
- package/content/container-blocks/googlemaps.md +546 -0
- package/content/container-blocks/googlemapsheatmap.md +607 -0
- package/content/container-blocks/googlemapsscript.md +61 -0
- package/content/container-blocks/header.md +302 -0
- package/content/container-blocks/label.md +739 -0
- package/content/container-blocks/layout.md +604 -0
- package/content/container-blocks/masonry.md +1090 -0
- package/content/container-blocks/mobilemenu.md +1244 -0
- package/content/container-blocks/modal.md +1180 -0
- package/content/container-blocks/pageheadermenu.md +614 -0
- package/content/container-blocks/pagesidebarlayout.md +438 -0
- package/content/container-blocks/pagesidermenu.md +651 -0
- package/content/container-blocks/popover.md +1421 -0
- package/content/container-blocks/result.md +972 -0
- package/content/container-blocks/sider.md +1064 -0
- package/content/container-blocks/span.md +747 -0
- package/content/container-blocks/spinner.md +267 -0
- package/content/container-blocks/splitter.md +1735 -0
- package/content/container-blocks/tabs.md +1718 -0
- package/content/container-blocks/tooltip.md +1274 -0
- package/content/container-blocks/watermark.md +515 -0
- package/content/controls/for.md +103 -0
- package/content/controls/if.md +107 -0
- package/content/controls/log.md +50 -0
- package/content/controls/parallel.md +71 -0
- package/content/controls/parallel_for.md +36 -0
- package/content/controls/reject.md +56 -0
- package/content/controls/return.md +66 -0
- package/content/controls/set_state.md +98 -0
- package/content/controls/switch.md +90 -0
- package/content/controls/throw.md +79 -0
- package/content/controls/try.md +88 -0
- package/content/deployment/docker.md +149 -0
- package/content/deployment/node-server.md +27 -0
- package/content/deployment/vercel.md +101 -0
- package/content/display-blocks/aggrid.md +1459 -0
- package/content/display-blocks/anchor.md +336 -0
- package/content/display-blocks/avatar.md +1154 -0
- package/content/display-blocks/breadcrumb.md +517 -0
- package/content/display-blocks/button.md +758 -0
- package/content/display-blocks/calendar.md +156 -0
- package/content/display-blocks/dangeroushtml.md +314 -0
- package/content/display-blocks/dangerousmarkdown.md +423 -0
- package/content/display-blocks/diffgit.md +44 -0
- package/content/display-blocks/difflist.md +225 -0
- package/content/display-blocks/diffsidebyside.md +56 -0
- package/content/display-blocks/difftimeline.md +94 -0
- package/content/display-blocks/divider.md +406 -0
- package/content/display-blocks/download.md +60 -0
- package/content/display-blocks/dropdownbutton.md +661 -0
- package/content/display-blocks/echart.md +418 -0
- package/content/display-blocks/floatbutton.md +545 -0
- package/content/display-blocks/html.md +311 -0
- package/content/display-blocks/icon.md +717 -0
- package/content/display-blocks/img.md +479 -0
- package/content/display-blocks/markdown.md +520 -0
- package/content/display-blocks/markdownwithcode.md +730 -0
- package/content/display-blocks/menu.md +1123 -0
- package/content/display-blocks/message.md +941 -0
- package/content/display-blocks/notification.md +1410 -0
- package/content/display-blocks/paragraph.md +643 -0
- package/content/display-blocks/progress.md +818 -0
- package/content/display-blocks/qrcode.md +519 -0
- package/content/display-blocks/s3download.md +240 -0
- package/content/display-blocks/search.md +360 -0
- package/content/display-blocks/skeleton.md +272 -0
- package/content/display-blocks/skeletonavatar.md +222 -0
- package/content/display-blocks/skeletonbutton.md +245 -0
- package/content/display-blocks/skeletoninput.md +223 -0
- package/content/display-blocks/skeletonparagraph.md +201 -0
- package/content/display-blocks/statistic.md +485 -0
- package/content/display-blocks/steps.md +585 -0
- package/content/display-blocks/tag.md +620 -0
- package/content/display-blocks/title.md +654 -0
- package/content/display-blocks/tour.md +2359 -0
- package/content/input-blocks/autocomplete.md +786 -0
- package/content/input-blocks/buttonselector.md +964 -0
- package/content/input-blocks/checkboxselector.md +765 -0
- package/content/input-blocks/checkboxswitch.md +497 -0
- package/content/input-blocks/colorselector.md +884 -0
- package/content/input-blocks/daterangeselector.md +777 -0
- package/content/input-blocks/dateselector.md +693 -0
- package/content/input-blocks/datetimeselector.md +791 -0
- package/content/input-blocks/inputgallery.md +528 -0
- package/content/input-blocks/monthselector.md +717 -0
- package/content/input-blocks/multipleselector.md +1337 -0
- package/content/input-blocks/numberinput.md +855 -0
- package/content/input-blocks/pagination.md +679 -0
- package/content/input-blocks/paragraphinput.md +1664 -0
- package/content/input-blocks/passwordinput.md +480 -0
- package/content/input-blocks/phonenumberinput.md +688 -0
- package/content/input-blocks/radioselector.md +820 -0
- package/content/input-blocks/ratingslider.md +684 -0
- package/content/input-blocks/s3uploadbutton.md +384 -0
- package/content/input-blocks/s3uploaddragger.md +305 -0
- package/content/input-blocks/s3uploadphoto.md +288 -0
- package/content/input-blocks/segmentedselector.md +782 -0
- package/content/input-blocks/selector.md +1162 -0
- package/content/input-blocks/switch.md +552 -0
- package/content/input-blocks/textarea.md +714 -0
- package/content/input-blocks/textinput.md +639 -0
- package/content/input-blocks/tiptapinput.md +226 -0
- package/content/input-blocks/tiptapmentioninput.md +471 -0
- package/content/input-blocks/titleinput.md +1094 -0
- package/content/input-blocks/treeinput.md +144 -0
- package/content/input-blocks/treemultipleselector.md +162 -0
- package/content/input-blocks/treeselector.md +185 -0
- package/content/input-blocks/upload.md +149 -0
- package/content/input-blocks/uploaddragger.md +85 -0
- package/content/input-blocks/uploadphoto.md +84 -0
- package/content/input-blocks/weekselector.md +630 -0
- package/content/list-blocks/controlledlist.md +498 -0
- package/content/list-blocks/list.md +529 -0
- package/content/list-blocks/listselector.md +301 -0
- package/content/list-blocks/masonrylist.md +230 -0
- package/content/migration/upgrade-guide.md +106 -0
- package/content/migration/v4-to-v5.md +589 -0
- package/content/migration/v5-to-v6.md +36 -0
- package/content/operators/_actions.md +58 -0
- package/content/operators/_and.md +76 -0
- package/content/operators/_api.md +254 -0
- package/content/operators/_app.md +114 -0
- package/content/operators/_args.md +65 -0
- package/content/operators/_array.md +331 -0
- package/content/operators/_base64.md +49 -0
- package/content/operators/_boolean.md +33 -0
- package/content/operators/_build.md +166 -0
- package/content/operators/_change_case.md +357 -0
- package/content/operators/_date.md +415 -0
- package/content/operators/_dayjs.md +128 -0
- package/content/operators/_diff.md +61 -0
- package/content/operators/_divide.md +32 -0
- package/content/operators/_eq.md +52 -0
- package/content/operators/_event.md +86 -0
- package/content/operators/_function.md +52 -0
- package/content/operators/_get.md +92 -0
- package/content/operators/_global.md +86 -0
- package/content/operators/_gt.md +50 -0
- package/content/operators/_gte.md +50 -0
- package/content/operators/_hash.md +112 -0
- package/content/operators/_if.md +30 -0
- package/content/operators/_if_none.md +47 -0
- package/content/operators/_index.md +48 -0
- package/content/operators/_input.md +86 -0
- package/content/operators/_intl.md +135 -0
- package/content/operators/_item.md +166 -0
- package/content/operators/_js.md +113 -0
- package/content/operators/_json.md +120 -0
- package/content/operators/_jsonata.md +152 -0
- package/content/operators/_locale.md +65 -0
- package/content/operators/_location.md +40 -0
- package/content/operators/_log.md +22 -0
- package/content/operators/_lt.md +50 -0
- package/content/operators/_lte.md +50 -0
- package/content/operators/_math.md +407 -0
- package/content/operators/_media.md +83 -0
- package/content/operators/_menu.md +62 -0
- package/content/operators/_module.md +340 -0
- package/content/operators/_mql.md +95 -0
- package/content/operators/_ne.md +62 -0
- package/content/operators/_not.md +33 -0
- package/content/operators/_number.md +159 -0
- package/content/operators/_nunjucks.md +117 -0
- package/content/operators/_object.md +253 -0
- package/content/operators/_operator.md +33 -0
- package/content/operators/_or.md +67 -0
- package/content/operators/_product.md +45 -0
- package/content/operators/_random.md +90 -0
- package/content/operators/_ref.md +80 -0
- package/content/operators/_regex.md +69 -0
- package/content/operators/_request.md +35 -0
- package/content/operators/_request_details.md +29 -0
- package/content/operators/_secret.md +56 -0
- package/content/operators/_state.md +134 -0
- package/content/operators/_step.md +98 -0
- package/content/operators/_string.md +327 -0
- package/content/operators/_subtract.md +24 -0
- package/content/operators/_sum.md +45 -0
- package/content/operators/_switch.md +37 -0
- package/content/operators/_t.md +96 -0
- package/content/operators/_theme.md +65 -0
- package/content/operators/_type.md +78 -0
- package/content/operators/_uri.md +49 -0
- package/content/operators/_url_query.md +92 -0
- package/content/operators/_user.md +154 -0
- package/content/operators/_uuid.md +118 -0
- package/content/operators/_var.md +88 -0
- package/content/operators/_yaml.md +96 -0
- package/content/other/introduction.md +39 -0
- package/content/other/next-auth-providers.md +3 -0
- package/content/other/updatesession.md +26 -0
- package/content/plugins/plugins-actions.md +80 -0
- package/content/plugins/plugins-connections.md +98 -0
- package/content/plugins/plugins-dev.md +138 -0
- package/content/plugins/plugins-introduction.md +29 -0
- package/content/plugins/plugins-operators.md +71 -0
- package/content/testing/e2e-auth.md +108 -0
- package/content/testing/e2e-configuration.md +107 -0
- package/content/testing/e2e-getting-started.md +96 -0
- package/content/testing/e2e-introduction.md +53 -0
- package/content/testing/e2e-mocking.md +155 -0
- package/content/testing/e2e-writing-tests.md +214 -0
- package/content/tutorial/tutorial-actions-operators.md +222 -0
- package/content/tutorial/tutorial-add-blocks.md +86 -0
- package/content/tutorial/tutorial-create-page.md +57 -0
- package/content/tutorial/tutorial-display-data-page.md +181 -0
- package/content/tutorial/tutorial-next-steps.md +53 -0
- package/content/tutorial/tutorial-requests-sql.md +22 -0
- package/content/tutorial/tutorial-start.md +71 -0
- package/content/user-authentication/auth-providers.md +15 -0
- package/content/user-authentication/login-and-logout.md +122 -0
- package/content/user-authentication/users-introduction.md +31 -0
- package/index.json +2281 -0
- package/package.json +34 -0
- package/scripts/extractAgentDocs.js +130 -0
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
# MariaDB
|
|
2
|
+
|
|
3
|
+
The [Knex](/Knex) connection can be used to connect to a [MariaDB](https://www.mysql.com) database. To connect to a MariaDB database, use the `mysql2` client — knex does not have a separate `mariadb` client.
|
|
4
|
+
|
|
5
|
+
## Connections
|
|
6
|
+
|
|
7
|
+
Connection types:
|
|
8
|
+
- Knex
|
|
9
|
+
|
|
10
|
+
### Knex
|
|
11
|
+
|
|
12
|
+
#### Properties
|
|
13
|
+
- `client: enum`: __Required__ - Use the `mysql2` client to connect to MariaDB.
|
|
14
|
+
- `connection: object | string `: __Required__ - Connection object or string to pass to the [`mysql2`](https://www.npmjs.com/package/mysql2) database client.
|
|
15
|
+
- `version: string`: Set database version.
|
|
16
|
+
- `useNullAsDefault: boolean`: If true, undefined keys are replaced with NULL instead of DEFAULT.
|
|
17
|
+
|
|
18
|
+
#### Examples
|
|
19
|
+
|
|
20
|
+
###### Connection object:
|
|
21
|
+
```yaml
|
|
22
|
+
connections:
|
|
23
|
+
- id: mariadb
|
|
24
|
+
type: Knex
|
|
25
|
+
properties:
|
|
26
|
+
client: mysql2
|
|
27
|
+
connection:
|
|
28
|
+
host:
|
|
29
|
+
_secret: MARIADB_HOST
|
|
30
|
+
database:
|
|
31
|
+
_secret: MARIADB_DB
|
|
32
|
+
user:
|
|
33
|
+
_secret: MARIADB_USER
|
|
34
|
+
password:
|
|
35
|
+
_secret: MARIADB_PASSWORD
|
|
36
|
+
```
|
|
37
|
+
Environment variables:
|
|
38
|
+
```
|
|
39
|
+
LOWDEFY_SECRET_MARIADB_HOST = database.server.com
|
|
40
|
+
LOWDEFY_SECRET_MARIADB_DB = db
|
|
41
|
+
LOWDEFY_SECRET_MARIADB_USER = user
|
|
42
|
+
LOWDEFY_SECRET_MARIADB_PASSWORD = password
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Requests
|
|
46
|
+
|
|
47
|
+
Request types:
|
|
48
|
+
|
|
49
|
+
- KnexBuilder
|
|
50
|
+
- KnexRaw
|
|
51
|
+
|
|
52
|
+
### KnexBuilder
|
|
53
|
+
|
|
54
|
+
#### Properties
|
|
55
|
+
|
|
56
|
+
- `query: object[]`: **Required** - SQL query builder array. An array of objects, with a single key which is the name of the knex builder function. The value should be an array of arguments to pass to the builder function.
|
|
57
|
+
- `tableName: string | object`: The name of the table to query from.
|
|
58
|
+
|
|
59
|
+
#### Examples
|
|
60
|
+
|
|
61
|
+
###### Build a query:
|
|
62
|
+
|
|
63
|
+
```yaml
|
|
64
|
+
id: knexBuilder
|
|
65
|
+
type: KnexBuilder
|
|
66
|
+
connectionId: knex
|
|
67
|
+
payload:
|
|
68
|
+
name:
|
|
69
|
+
_state: name
|
|
70
|
+
properties:
|
|
71
|
+
query:
|
|
72
|
+
- select:
|
|
73
|
+
- '*'
|
|
74
|
+
- from:
|
|
75
|
+
- users
|
|
76
|
+
- where:
|
|
77
|
+
- name
|
|
78
|
+
- _payload: name
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
###### Using `tableName`:
|
|
82
|
+
|
|
83
|
+
```yaml
|
|
84
|
+
id: knexBuilder
|
|
85
|
+
type: KnexBuilder
|
|
86
|
+
connectionId: knex
|
|
87
|
+
payload:
|
|
88
|
+
name:
|
|
89
|
+
_state: name
|
|
90
|
+
properties:
|
|
91
|
+
tableName: users
|
|
92
|
+
query:
|
|
93
|
+
- select:
|
|
94
|
+
- '*'
|
|
95
|
+
- where:
|
|
96
|
+
- name
|
|
97
|
+
- _payload: name
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
###### Aliases:
|
|
101
|
+
|
|
102
|
+
```yaml
|
|
103
|
+
id: knexBuilder
|
|
104
|
+
type: KnexBuilder
|
|
105
|
+
connectionId: knex
|
|
106
|
+
properties:
|
|
107
|
+
tableName:
|
|
108
|
+
a: tableA
|
|
109
|
+
b: tableB
|
|
110
|
+
query:
|
|
111
|
+
- select:
|
|
112
|
+
- aField: 'a.field'
|
|
113
|
+
- bField: 'b.field'
|
|
114
|
+
- limit:
|
|
115
|
+
- 1
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### KnexRaw
|
|
119
|
+
|
|
120
|
+
#### Properties
|
|
121
|
+
|
|
122
|
+
- `query: string`: **Required** - SQL query string.
|
|
123
|
+
- `parameters: string | number | array | object`: SQL query parameters.
|
|
124
|
+
|
|
125
|
+
#### Examples
|
|
126
|
+
|
|
127
|
+
###### Simple raw query:
|
|
128
|
+
|
|
129
|
+
```yaml
|
|
130
|
+
id: knexRaw
|
|
131
|
+
type: KnexRaw
|
|
132
|
+
connectionId: knex
|
|
133
|
+
properties:
|
|
134
|
+
query: SELECT * FROM "my_table";
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
###### Query with named parameters:
|
|
138
|
+
|
|
139
|
+
```yaml
|
|
140
|
+
id: knexRaw
|
|
141
|
+
type: KnexRaw
|
|
142
|
+
connectionId: knex
|
|
143
|
+
payload:
|
|
144
|
+
selected_name:
|
|
145
|
+
_state: selected_name
|
|
146
|
+
properties:
|
|
147
|
+
query: select * from users where name = :name
|
|
148
|
+
parameters:
|
|
149
|
+
name:
|
|
150
|
+
_payload: selected_name
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
###### Query with positional parameters:
|
|
154
|
+
|
|
155
|
+
```yaml
|
|
156
|
+
id: knexRaw
|
|
157
|
+
type: KnexRaw
|
|
158
|
+
connectionId: knex
|
|
159
|
+
payload:
|
|
160
|
+
selected_name:
|
|
161
|
+
_state: selected_name
|
|
162
|
+
properties:
|
|
163
|
+
query: select * from users where name = ?
|
|
164
|
+
parameters:
|
|
165
|
+
- _payload: selected_name
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
###### Reference a `.sql` file:
|
|
169
|
+
|
|
170
|
+
```yaml
|
|
171
|
+
id: knexRaw
|
|
172
|
+
type: KnexRaw
|
|
173
|
+
connectionId: knex
|
|
174
|
+
properties:
|
|
175
|
+
query:
|
|
176
|
+
_ref: my_query.sql
|
|
177
|
+
```
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
# MCP
|
|
2
|
+
|
|
3
|
+
The MCP connection defines a [Model Context Protocol](https://modelcontextprotocol.io/) server that provides tools to [Lowdefy agents](/agents-introduction). MCP is an open standard for connecting AI models to external tools and data sources.
|
|
4
|
+
|
|
5
|
+
> The MCP connection is provided by the `@lowdefy/connection-mcp` package, which is included by default.
|
|
6
|
+
|
|
7
|
+
MCP connections are referenced from the `mcp` array on an agent. The agent automatically discovers and uses the tools the MCP server provides. See [MCP Tools](/agent-mcp-tools) for details on using MCP with agents and for inline configuration without a connection.
|
|
8
|
+
|
|
9
|
+
## Connections
|
|
10
|
+
|
|
11
|
+
### Mcp
|
|
12
|
+
|
|
13
|
+
#### Properties
|
|
14
|
+
|
|
15
|
+
| Property | Type | Default | Description |
|
|
16
|
+
| --- | --- | --- | --- |
|
|
17
|
+
| `transport` | string | `'http'` | Transport protocol: `'http'`, `'sse'`, or `'stdio'`. |
|
|
18
|
+
| `url` | string | | URL for the MCP server. Required for `http` and `sse` transports. |
|
|
19
|
+
| `headers` | object | | HTTP headers. Only for `http` and `sse`. __Operators are evaluated__. |
|
|
20
|
+
| `command` | string | | Command to run. Required for `stdio` transport. |
|
|
21
|
+
| `args` | string[] | | Arguments for the stdio command. |
|
|
22
|
+
| `env` | object | | Environment variables for the stdio command. __Operators are evaluated__. |
|
|
23
|
+
|
|
24
|
+
### HTTP Transport
|
|
25
|
+
|
|
26
|
+
Connect to a remote MCP server over HTTP:
|
|
27
|
+
|
|
28
|
+
```yaml
|
|
29
|
+
connections:
|
|
30
|
+
- id: mcp_tools
|
|
31
|
+
type: Mcp
|
|
32
|
+
properties:
|
|
33
|
+
url: https://mcp.example.com/tools
|
|
34
|
+
transport: http
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
###### With authentication:
|
|
38
|
+
```yaml
|
|
39
|
+
connections:
|
|
40
|
+
- id: mcp_tools
|
|
41
|
+
type: Mcp
|
|
42
|
+
properties:
|
|
43
|
+
url: https://mcp.example.com/tools
|
|
44
|
+
transport: http
|
|
45
|
+
headers:
|
|
46
|
+
Authorization:
|
|
47
|
+
_string.concat:
|
|
48
|
+
- 'Bearer '
|
|
49
|
+
- _secret: MCP_API_KEY
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### SSE Transport
|
|
53
|
+
|
|
54
|
+
Connect using Server-Sent Events:
|
|
55
|
+
|
|
56
|
+
```yaml
|
|
57
|
+
connections:
|
|
58
|
+
- id: mcp_sse
|
|
59
|
+
type: Mcp
|
|
60
|
+
properties:
|
|
61
|
+
url: https://mcp.example.com/sse
|
|
62
|
+
transport: sse
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### Stdio Transport
|
|
66
|
+
|
|
67
|
+
Launch a local MCP server process. Useful for npm-published MCP servers:
|
|
68
|
+
|
|
69
|
+
###### File system access:
|
|
70
|
+
```yaml
|
|
71
|
+
connections:
|
|
72
|
+
- id: mcp_filesystem
|
|
73
|
+
type: Mcp
|
|
74
|
+
properties:
|
|
75
|
+
transport: stdio
|
|
76
|
+
command: npx
|
|
77
|
+
args:
|
|
78
|
+
- '-y'
|
|
79
|
+
- '@modelcontextprotocol/server-filesystem'
|
|
80
|
+
- '/data/documents'
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
###### GitHub integration:
|
|
84
|
+
```yaml
|
|
85
|
+
connections:
|
|
86
|
+
- id: mcp_github
|
|
87
|
+
type: Mcp
|
|
88
|
+
properties:
|
|
89
|
+
transport: stdio
|
|
90
|
+
command: npx
|
|
91
|
+
args:
|
|
92
|
+
- '-y'
|
|
93
|
+
- '@modelcontextprotocol/server-github'
|
|
94
|
+
env:
|
|
95
|
+
GITHUB_TOKEN:
|
|
96
|
+
_secret: GITHUB_TOKEN
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
###### Custom server with environment variables:
|
|
100
|
+
```yaml
|
|
101
|
+
connections:
|
|
102
|
+
- id: mcp_database
|
|
103
|
+
type: Mcp
|
|
104
|
+
properties:
|
|
105
|
+
transport: stdio
|
|
106
|
+
command: node
|
|
107
|
+
args:
|
|
108
|
+
- ./mcp-servers/database.js
|
|
109
|
+
env:
|
|
110
|
+
DATABASE_URL:
|
|
111
|
+
_secret: DATABASE_URL
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
## Usage
|
|
115
|
+
|
|
116
|
+
Reference MCP connections in the `mcp` array on an agent:
|
|
117
|
+
|
|
118
|
+
```yaml
|
|
119
|
+
agents:
|
|
120
|
+
- id: dev_assistant
|
|
121
|
+
type: ClaudeAgent
|
|
122
|
+
connectionId: anthropic
|
|
123
|
+
properties:
|
|
124
|
+
model: claude-sonnet-4-20250514
|
|
125
|
+
instructions: |
|
|
126
|
+
You help developers with code and GitHub issues.
|
|
127
|
+
Use GitHub tools to search issues, read files,
|
|
128
|
+
and create pull requests.
|
|
129
|
+
mcp:
|
|
130
|
+
- mcp_github
|
|
131
|
+
- mcp_filesystem
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
MCP servers can also be defined inline on the agent without a connection. See [MCP Tools](/agent-mcp-tools) for inline configuration.
|