productivity
1Password Connect Lua API for KosmoKrator Agents
Agent-facing Lua documentation and function reference for the 1Password Connect KosmoKrator integration.Lua Namespace
Agents call this integration through app.integrations.onepassword_connect.*.
Use lua_read_doc("integrations.onepassword-connect") inside KosmoKrator to discover the same reference at runtime.
Call Lua from the Headless CLI
Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic
1Password Connect workflow without starting an interactive agent session.
kosmo integrations:lua --eval 'dump(app.integrations.onepassword_connect.get_api_activity({}))' --json kosmo integrations:lua --eval 'print(docs.read("onepassword-connect"))' --json
kosmo integrations:lua --eval 'print(docs.read("onepassword-connect.get_api_activity"))' --json Workflow file
Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.
local onepassword_connect = app.integrations.onepassword_connect
local result = onepassword_connect.get_api_activity({})
dump(result) kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json integrations:lua exposes app.integrations.onepassword_connect, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.onepassword_connect.default.* or app.integrations.onepassword_connect.work.* when you configured named credential accounts.
MCP-only Lua
If the script only needs configured MCP servers and does not need 1Password Connect, use the narrower mcp:lua command.
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json Agent-Facing Lua Docs
This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.
1Password Connect Lua Tools
Namespace: onepassword-connect
Generated from the official 1Password Connect API specification file version 1.8.1. Configure url with the Connect Server API base URL, usually http://localhost:8080/v1, and api_token with a Connect access token.
Coverage
- Paths: 11
- Tools: 15
- Read tools: 11
- Write tools: 4
Usage Notes
- Path and query parameters use snake_case tool keys and are sent with official API names.
- JSON request payloads for create, update, and patch operations go in
body. - File content endpoints may return non-JSON data; non-JSON responses are returned as
{ body = ..., status = ... }.
Example Lua
local vaults = onepassword_connect.onepassword_connect_get_vaults({})
local items = onepassword_connect.onepassword_connect_get_vault_items({ vault_uuid = "vault-id" })Raw agent markdown
# 1Password Connect Lua Tools
Namespace: `onepassword-connect`
Generated from the official 1Password Connect API specification file version 1.8.1. Configure `url` with the Connect Server API base URL, usually `http://localhost:8080/v1`, and `api_token` with a Connect access token.
## Coverage
- Paths: 11
- Tools: 15
- Read tools: 11
- Write tools: 4
## Usage Notes
- Path and query parameters use snake_case tool keys and are sent with official API names.
- JSON request payloads for create, update, and patch operations go in `body`.
- File content endpoints may return non-JSON data; non-JSON responses are returned as `{ body = ..., status = ... }`.
## Example Lua
```lua
local vaults = onepassword_connect.onepassword_connect_get_vaults({})
local items = onepassword_connect.onepassword_connect_get_vault_items({ vault_uuid = "vault-id" })
``` local result = app.integrations.onepassword_connect.get_api_activity({})
print(result) Functions
get_api_activity Read
Retrieve a list of API Requests that have been made. Official 1Password Connect endpoint: GET /activity.
- Lua path
app.integrations.onepassword_connect.get_api_activity- Full name
onepassword-connect.onepassword_connect_get_api_activity
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_vaults Read
Get all Vaults Official 1Password Connect endpoint: GET /vaults.
- Lua path
app.integrations.onepassword_connect.get_vaults- Full name
onepassword-connect.onepassword_connect_get_vaults
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_vault_by_id Read
Get Vault details and metadata Official 1Password Connect endpoint: GET /vaults/{vaultUuid}.
- Lua path
app.integrations.onepassword_connect.get_vault_by_id- Full name
onepassword-connect.onepassword_connect_get_vault_by_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_vault_items Read
Get all items for inside a Vault Official 1Password Connect endpoint: GET /vaults/{vaultUuid}/items.
- Lua path
app.integrations.onepassword_connect.get_vault_items- Full name
onepassword-connect.onepassword_connect_get_vault_items
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_vault_item Write
Create a new Item Official 1Password Connect endpoint: POST /vaults/{vaultUuid}/items.
- Lua path
app.integrations.onepassword_connect.create_vault_item- Full name
onepassword-connect.onepassword_connect_create_vault_item
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_vault_item_by_id Read
Get the details of an Item Official 1Password Connect endpoint: GET /vaults/{vaultUuid}/items/{itemUuid}.
- Lua path
app.integrations.onepassword_connect.get_vault_item_by_id- Full name
onepassword-connect.onepassword_connect_get_vault_item_by_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_vault_item Write
Update an Item Official 1Password Connect endpoint: PUT /vaults/{vaultUuid}/items/{itemUuid}.
- Lua path
app.integrations.onepassword_connect.update_vault_item- Full name
onepassword-connect.onepassword_connect_update_vault_item
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_vault_item Write
Delete an Item Official 1Password Connect endpoint: DELETE /vaults/{vaultUuid}/items/{itemUuid}.
- Lua path
app.integrations.onepassword_connect.delete_vault_item- Full name
onepassword-connect.onepassword_connect_delete_vault_item
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
patch_vault_item Write
Applies a modified [RFC6902 JSON Patch](https://tools.ietf.org/html/rfc6902) document to an Item or ItemField. This endpoint only supports `add`, `remove` and `replace` operations. When modifying a specific ItemField, the ItemField's ID in the `path` attribute
- Lua path
app.integrations.onepassword_connect.patch_vault_item- Full name
onepassword-connect.onepassword_connect_patch_vault_item
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_item_files Read
Get all the files inside an Item Official 1Password Connect endpoint: GET /vaults/{vaultUuid}/items/{itemUuid}/files.
- Lua path
app.integrations.onepassword_connect.get_item_files- Full name
onepassword-connect.onepassword_connect_get_item_files
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_details_file_by_id Read
Get the details of a File Official 1Password Connect endpoint: GET /vaults/{vaultUuid}/items/{itemUuid}/files/{fileUuid}.
- Lua path
app.integrations.onepassword_connect.get_details_file_by_id- Full name
onepassword-connect.onepassword_connect_get_details_of_file_by_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
download_file_by_id Read
Get the content of a File Official 1Password Connect endpoint: GET /vaults/{vaultUuid}/items/{itemUuid}/files/{fileUuid}/content.
- Lua path
app.integrations.onepassword_connect.download_file_by_id- Full name
onepassword-connect.onepassword_connect_download_file_by_id
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_heartbeat Read
Ping the server for liveness Official 1Password Connect endpoint: GET /heartbeat.
- Lua path
app.integrations.onepassword_connect.get_heartbeat- Full name
onepassword-connect.onepassword_connect_get_heartbeat
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_server_health Read
Get state of the server and its dependencies. Official 1Password Connect endpoint: GET /health.
- Lua path
app.integrations.onepassword_connect.get_server_health- Full name
onepassword-connect.onepassword_connect_get_server_health
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_prometheus_metrics Read
See Prometheus documentation for a complete data model. Official 1Password Connect endpoint: GET /metrics.
- Lua path
app.integrations.onepassword_connect.get_prometheus_metrics- Full name
onepassword-connect.onepassword_connect_get_prometheus_metrics
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||