KosmoKrator

productivity

Miniflux Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Miniflux KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.miniflux.*. Use lua_read_doc("integrations.miniflux") 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 Miniflux workflow without starting an interactive agent session.

Inline Lua call 
kosmo integrations:lua --eval 'dump(app.integrations.miniflux.discover_subscriptions({}))' --json
Read Lua docs headlessly 
kosmo integrations:lua --eval 'print(docs.read("miniflux"))' --json
kosmo integrations:lua --eval 'print(docs.read("miniflux.discover_subscriptions"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua 
local miniflux = app.integrations.miniflux
local result = miniflux.discover_subscriptions({})

dump(result)
Run the workflow 
kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json
Namespace note. integrations:lua exposes app.integrations.miniflux, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.miniflux.default.* or app.integrations.miniflux.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Miniflux, use the narrower mcp:lua command.

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.

Miniflux

Namespace: miniflux

Use Miniflux tools to manage RSS feeds, categories, entries, bookmarks, users, API keys, OPML import/export, and instance health probes. Configure the root instance URL without /v1; the integration adds documented API paths itself.

Authentication prefers an API key sent as X-Auth-Token. Username/password Basic auth is supported as a fallback for older or manually configured hosts.

Common Workflows

  • miniflux_feeds_list lists feeds.
  • miniflux_feeds_create subscribes to a feed URL. Pass feed_url and, for older Miniflux versions, category_id.
  • miniflux_entries_list lists entries with filters such as status, limit, offset, order, direction, starred, search, and timestamp filters in payload.
  • miniflux_entries_update_status marks entry IDs as read, unread, or removed.
  • miniflux_entries_toggle_bookmark toggles an entry bookmark.
  • miniflux_opml_export returns OPML XML in value.
  • miniflux_opml_import sends the opml string as an XML request body.
  • miniflux_healthcheck, miniflux_liveness, and miniflux_readiness return probe text in value when the instance responds with plain text.

Response Shape

JSON responses are returned as:

{
  status = 200,
  data = { ... }
}

Empty successful responses return:

{
  status = 204,
  success = true
}

Plain text and XML responses return:

{
  status = 200,
  value = "OK"
}

Raw API Tools

Use miniflux_api_get, miniflux_api_post, miniflux_api_put, miniflux_api_patch, and miniflux_api_delete only for supported Miniflux paths not yet represented by a named tool. Raw paths must be relative, for example /v1/feeds/counters; absolute URLs are rejected.

All examples should use fake public data in tests and docs.

Raw agent markdown 
# Miniflux

Namespace: `miniflux`

Use Miniflux tools to manage RSS feeds, categories, entries, bookmarks, users,
API keys, OPML import/export, and instance health probes. Configure the root
instance URL without `/v1`; the integration adds documented API paths itself.

Authentication prefers an API key sent as `X-Auth-Token`. Username/password
Basic auth is supported as a fallback for older or manually configured hosts.

## Common Workflows

- `miniflux_feeds_list` lists feeds.
- `miniflux_feeds_create` subscribes to a feed URL. Pass `feed_url` and, for
  older Miniflux versions, `category_id`.
- `miniflux_entries_list` lists entries with filters such as `status`, `limit`,
  `offset`, `order`, `direction`, `starred`, `search`, and timestamp filters in
  `payload`.
- `miniflux_entries_update_status` marks entry IDs as `read`, `unread`, or
  `removed`.
- `miniflux_entries_toggle_bookmark` toggles an entry bookmark.
- `miniflux_opml_export` returns OPML XML in `value`.
- `miniflux_opml_import` sends the `opml` string as an XML request body.
- `miniflux_healthcheck`, `miniflux_liveness`, and `miniflux_readiness` return
  probe text in `value` when the instance responds with plain text.

## Response Shape

JSON responses are returned as:

```lua
{
  status = 200,
  data = { ... }
}
```

Empty successful responses return:

```lua
{
  status = 204,
  success = true
}
```

Plain text and XML responses return:

```lua
{
  status = 200,
  value = "OK"
}
```

## Raw API Tools

Use `miniflux_api_get`, `miniflux_api_post`, `miniflux_api_put`,
`miniflux_api_patch`, and `miniflux_api_delete` only for supported Miniflux
paths not yet represented by a named tool. Raw paths must be relative, for
example `/v1/feeds/counters`; absolute URLs are rejected.

All examples should use fake public data in tests and docs.
Metadata-derived Lua example 
local result = app.integrations.miniflux.discover_subscriptions({})
print(result)

Functions

discover_subscriptions Read

Discover feeds from a website URL.

Lua path
app.integrations.miniflux.discover_subscriptions
Full name
miniflux.miniflux_discover
ParameterTypeRequiredDescription
No parameters.
flush_history Write

Flush removed entry history.

Lua path
app.integrations.miniflux.flush_history
Full name
miniflux.miniflux_flush_history
ParameterTypeRequiredDescription
No parameters.
list_feeds Read

List feeds visible to the authenticated user.

Lua path
app.integrations.miniflux.list_feeds
Full name
miniflux.miniflux_feeds_list
ParameterTypeRequiredDescription
No parameters.
list_category_feeds Read

List feeds in one category.

Lua path
app.integrations.miniflux.list_category_feeds
Full name
miniflux.miniflux_category_feeds_list
ParameterTypeRequiredDescription
No parameters.
get_feed Read

Get one feed.

Lua path
app.integrations.miniflux.get_feed
Full name
miniflux.miniflux_feeds_get
ParameterTypeRequiredDescription
No parameters.
get_feed_icon Read

Get a feed icon by feed ID.

Lua path
app.integrations.miniflux.get_feed_icon
Full name
miniflux.miniflux_feed_icon_get
ParameterTypeRequiredDescription
No parameters.
get_icon Read

Get a feed icon by icon ID.

Lua path
app.integrations.miniflux.get_icon
Full name
miniflux.miniflux_icon_get
ParameterTypeRequiredDescription
No parameters.
mark_feed_read Write

Mark all entries in one feed as read.

Lua path
app.integrations.miniflux.mark_feed_read
Full name
miniflux.miniflux_feeds_mark_all_read
ParameterTypeRequiredDescription
No parameters.
create_feed Write

Subscribe to a feed URL.

Lua path
app.integrations.miniflux.create_feed
Full name
miniflux.miniflux_feeds_create
ParameterTypeRequiredDescription
No parameters.
update_feed Write

Update feed settings.

Lua path
app.integrations.miniflux.update_feed
Full name
miniflux.miniflux_feeds_update
ParameterTypeRequiredDescription
No parameters.
refresh_feed Write

Refresh one feed synchronously.

Lua path
app.integrations.miniflux.refresh_feed
Full name
miniflux.miniflux_feeds_refresh
ParameterTypeRequiredDescription
No parameters.
refresh_all_feeds Write

Refresh all feeds in the background.

Lua path
app.integrations.miniflux.refresh_all_feeds
Full name
miniflux.miniflux_feeds_refresh_all
ParameterTypeRequiredDescription
No parameters.
delete_feed Write

Remove one feed.

Lua path
app.integrations.miniflux.delete_feed
Full name
miniflux.miniflux_feeds_delete
ParameterTypeRequiredDescription
No parameters.
get_feed_entry Read

Get one entry scoped to a feed.

Lua path
app.integrations.miniflux.get_feed_entry
Full name
miniflux.miniflux_feed_entry_get
ParameterTypeRequiredDescription
No parameters.
get_entry Read

Get one entry.

Lua path
app.integrations.miniflux.get_entry
Full name
miniflux.miniflux_entries_get
ParameterTypeRequiredDescription
No parameters.
import_entry Write

Import a manual entry into a feed.

Lua path
app.integrations.miniflux.import_entry
Full name
miniflux.miniflux_entries_import
ParameterTypeRequiredDescription
No parameters.
update_entry Write

Update one entry title or content.

Lua path
app.integrations.miniflux.update_entry
Full name
miniflux.miniflux_entries_update
ParameterTypeRequiredDescription
No parameters.
save_entry Write

Save one entry to configured third-party services.

Lua path
app.integrations.miniflux.save_entry
Full name
miniflux.miniflux_entries_save
ParameterTypeRequiredDescription
No parameters.
fetch_original_article Read

Fetch original article content for one entry.

Lua path
app.integrations.miniflux.fetch_original_article
Full name
miniflux.miniflux_entries_fetch_content
ParameterTypeRequiredDescription
No parameters.
list_feed_entries Read

List entries from one feed.

Lua path
app.integrations.miniflux.list_feed_entries
Full name
miniflux.miniflux_feed_entries_list
ParameterTypeRequiredDescription
No parameters.
list_category_entries Read

List entries from one category.

Lua path
app.integrations.miniflux.list_category_entries
Full name
miniflux.miniflux_category_entries_list
ParameterTypeRequiredDescription
No parameters.
list_entries Read

List entries with filters and pagination.

Lua path
app.integrations.miniflux.list_entries
Full name
miniflux.miniflux_entries_list
ParameterTypeRequiredDescription
No parameters.
update_entry_statuses Write

Batch update entry read status.

Lua path
app.integrations.miniflux.update_entry_statuses
Full name
miniflux.miniflux_entries_update_status
ParameterTypeRequiredDescription
No parameters.
toggle_bookmark Write

Toggle one entry bookmark.

Lua path
app.integrations.miniflux.toggle_bookmark
Full name
miniflux.miniflux_entries_toggle_bookmark
ParameterTypeRequiredDescription
No parameters.
get_enclosure Read

Get one media enclosure.

Lua path
app.integrations.miniflux.get_enclosure
Full name
miniflux.miniflux_enclosures_get
ParameterTypeRequiredDescription
No parameters.
update_enclosure Write

Update enclosure media progression.

Lua path
app.integrations.miniflux.update_enclosure
Full name
miniflux.miniflux_enclosures_update
ParameterTypeRequiredDescription
No parameters.
list_categories Read

List categories, optionally with counts.

Lua path
app.integrations.miniflux.list_categories
Full name
miniflux.miniflux_categories_list
ParameterTypeRequiredDescription
No parameters.
create_category Write

Create a category.

Lua path
app.integrations.miniflux.create_category
Full name
miniflux.miniflux_categories_create
ParameterTypeRequiredDescription
No parameters.
update_category Write

Update a category.

Lua path
app.integrations.miniflux.update_category
Full name
miniflux.miniflux_categories_update
ParameterTypeRequiredDescription
No parameters.
refresh_category_feeds Write

Refresh feeds in one category.

Lua path
app.integrations.miniflux.refresh_category_feeds
Full name
miniflux.miniflux_categories_refresh
ParameterTypeRequiredDescription
No parameters.
delete_category Write

Delete one category.

Lua path
app.integrations.miniflux.delete_category
Full name
miniflux.miniflux_categories_delete
ParameterTypeRequiredDescription
No parameters.
mark_category_read Write

Mark all entries in one category as read.

Lua path
app.integrations.miniflux.mark_category_read
Full name
miniflux.miniflux_categories_mark_all_read
ParameterTypeRequiredDescription
No parameters.
export_opml Read

Export subscriptions as OPML XML.

Lua path
app.integrations.miniflux.export_opml
Full name
miniflux.miniflux_opml_export
ParameterTypeRequiredDescription
No parameters.
import_opml Write

Import subscriptions from OPML XML.

Lua path
app.integrations.miniflux.import_opml
Full name
miniflux.miniflux_opml_import
ParameterTypeRequiredDescription
No parameters.
create_user Write

Create a Miniflux user as an administrator.

Lua path
app.integrations.miniflux.create_user
Full name
miniflux.miniflux_users_create
ParameterTypeRequiredDescription
No parameters.
update_user Write

Update a Miniflux user as an administrator.

Lua path
app.integrations.miniflux.update_user
Full name
miniflux.miniflux_users_update
ParameterTypeRequiredDescription
No parameters.
get_current_user Read

Get the authenticated user.

Lua path
app.integrations.miniflux.get_current_user
Full name
miniflux.miniflux_me_get
ParameterTypeRequiredDescription
No parameters.
get_user Read

Get a user by ID or username as an administrator.

Lua path
app.integrations.miniflux.get_user
Full name
miniflux.miniflux_users_get
ParameterTypeRequiredDescription
No parameters.
list_users Read

List users as an administrator.

Lua path
app.integrations.miniflux.list_users
Full name
miniflux.miniflux_users_list
ParameterTypeRequiredDescription
No parameters.
delete_user Write

Delete a user as an administrator.

Lua path
app.integrations.miniflux.delete_user
Full name
miniflux.miniflux_users_delete
ParameterTypeRequiredDescription
No parameters.
integrations_status Read

Check whether the user has third-party save integrations enabled.

Lua path
app.integrations.miniflux.integrations_status
Full name
miniflux.miniflux_integrations_status
ParameterTypeRequiredDescription
No parameters.
mark_user_read Write

Mark all entries for one user as read.

Lua path
app.integrations.miniflux.mark_user_read
Full name
miniflux.miniflux_users_mark_all_read
ParameterTypeRequiredDescription
No parameters.
get_feed_counters Read

Fetch read and unread counters per feed.

Lua path
app.integrations.miniflux.get_feed_counters
Full name
miniflux.miniflux_feed_counters_get
ParameterTypeRequiredDescription
No parameters.
list_api_keys Read

List API keys for the authenticated user.

Lua path
app.integrations.miniflux.list_api_keys
Full name
miniflux.miniflux_api_keys_list
ParameterTypeRequiredDescription
No parameters.
create_api_key Write

Create an API key for the authenticated user.

Lua path
app.integrations.miniflux.create_api_key
Full name
miniflux.miniflux_api_keys_create
ParameterTypeRequiredDescription
No parameters.
delete_api_key Write

Delete an API key.

Lua path
app.integrations.miniflux.delete_api_key
Full name
miniflux.miniflux_api_keys_delete
ParameterTypeRequiredDescription
No parameters.
healthcheck Read

Check service and database health.

Lua path
app.integrations.miniflux.healthcheck
Full name
miniflux.miniflux_healthcheck
ParameterTypeRequiredDescription
No parameters.
liveness Read

Check process liveness.

Lua path
app.integrations.miniflux.liveness
Full name
miniflux.miniflux_liveness
ParameterTypeRequiredDescription
No parameters.
readiness Read

Check readiness to accept traffic.

Lua path
app.integrations.miniflux.readiness
Full name
miniflux.miniflux_readiness
ParameterTypeRequiredDescription
No parameters.
legacy_version Read

Fetch the deprecated plain-text version endpoint.

Lua path
app.integrations.miniflux.legacy_version
Full name
miniflux.miniflux_version_legacy
ParameterTypeRequiredDescription
No parameters.
version Read

Fetch version and build information.

Lua path
app.integrations.miniflux.version
Full name
miniflux.miniflux_version_get
ParameterTypeRequiredDescription
No parameters.
api_get Read

Call a safe relative Miniflux API GET path.

Lua path
app.integrations.miniflux.api_get
Full name
miniflux.miniflux_api_get
ParameterTypeRequiredDescription
No parameters.
api_post Write

Call a safe relative Miniflux API POST path.

Lua path
app.integrations.miniflux.api_post
Full name
miniflux.miniflux_api_post
ParameterTypeRequiredDescription
No parameters.
api_put Write

Call a safe relative Miniflux API PUT path.

Lua path
app.integrations.miniflux.api_put
Full name
miniflux.miniflux_api_put
ParameterTypeRequiredDescription
No parameters.
api_patch Write

Call a safe relative Miniflux API PATCH path.

Lua path
app.integrations.miniflux.api_patch
Full name
miniflux.miniflux_api_patch
ParameterTypeRequiredDescription
No parameters.
api_delete Write

Call a safe relative Miniflux API DELETE path.

Lua path
app.integrations.miniflux.api_delete
Full name
miniflux.miniflux_api_delete
ParameterTypeRequiredDescription
No parameters.