skip to content
iii / worker
$worker

openwiki

v0.1.0

Source-grounded markdown wiki for any git repository — openwiki::* functions generate, search, and incrementally refresh categorized pages with pinned-commit line citations, and the engine serves a browser UI + JSON API under /openwiki.

Experimental

Published as experimental by its release pipeline. It installs and resolves like any other worker, but its interface may change without notice.

iiiverified
2 installs2 in 7d0 today
install
$iii worker add openwiki@0.1.0
bundlewikidocumentationdocsmarkdownknowledge-baserepo
42functions0triggers1skills3depsv0.1.0version
repoiii-hq/workers

exact versions are immutable; binary and bundle artifacts are digest-pinned.

functions

42

openwiki::ask

function

Ask a question about a wiki; returns a cited answer. mode=fast (router) or deep (harness).

request
  • file_answerboolean

    File a good answer back into the wiki as a new page.

  • idstringrequired
  • modestringenum: fast, deep

    fast = router retrieval; deep = harness multi-hop.

  • qstringrequired
response
  • answerstringrequired
  • citationsobject[]
    • end_lineinteger
    • notestring
    • pathstringrequired
    • start_lineinteger
    • urlstring
  • filed_slugstring

openwiki::ask-question

function

MCP: ask a question about a wiki; returns a cited answer.

request
  • idstringrequired
  • qstringrequired
response
  • answerstringrequired
  • citationsobject[]
    • end_lineinteger
    • notestring
    • pathstringrequired
    • start_lineinteger
    • urlstring
  • filed_slugstring

openwiki::cron::refresh-due

function

Cron: refresh every wiki whose auto-refresh interval has elapsed.

request
empty object
response
  • refreshedintegerrequired

openwiki::delete

function

Delete a wiki and all its pages. Params: { id }.

request
  • idstringrequired
response
  • deletedbooleanrequired
  • idstringrequired

openwiki::diagram

function

Generate a Mermaid diagram (architecture|dataflow|deps) of a wiki.

request
  • idstringrequired
  • kindstringenum: architecture, dataflow, deps
response
  • kindstring
  • mermaidstringrequired

openwiki::export-agents-md

function

Build the AGENTS.md/CLAUDE.md pointer block for a wiki.

request
  • base_urlstring
  • idstringrequired
  • targetsstring[]enum: AGENTS.md, CLAUDE.md
response
  • contentstringrequired
  • targetsstring[]

openwiki::gen-stats

function

Measurement: source bytes the agent read and page bytes produced for a generation.

request
  • idstringrequired
response
  • output_bytesinteger
  • page_countinteger

openwiki::generate

function

Start generating a source-grounded wiki for a git repository URL. Returns immediately with { wiki_id, status }; poll openwiki::status.

request
  • modelstring

    Optional LLM model id, routed via llm-router.

  • refstring

    Optional branch/tag/commit to check out (default: default branch).

  • repo_urlstringrequired

    HTTPS git URL of a public repository.

  • steerobject

    Optional per-repo steering (repo_notes, explicit pages, caps). Mirrors openwiki.json.

response
  • statusstringrequired
  • wiki_idstringrequired

openwiki::http::ask

function

HTTP POST /openwiki/api/wikis/:id/ask

request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::diagram

function

HTTP GET /openwiki/api/wikis/:id/diagram

request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::events

function

HTTP GET /openwiki/api/wikis/:id/events (SSE live progress)

request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::models

function

HTTP GET /openwiki/api/models

request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::page-get

function

HTTP GET /openwiki/api/wikis/:id/pages/:slug

request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::pages-list

function

HTTP GET /openwiki/api/wikis/:id/pages

request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::refresh

function

HTTP POST /openwiki/api/wikis/:id/refresh

request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::schedule-set

function

HTTP PUT /openwiki/api/wikis/:id/schedule

request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::search

function

HTTP GET /openwiki/api/wikis/:id/search?q=

request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::ui

function

HTTP: serve the OpenWiki browser UI.

request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::wiki-delete

function

HTTP DELETE /openwiki/api/wikis/:id

request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::wiki-get

function

HTTP GET /openwiki/api/wikis/:id

request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::wiki-status

function

HTTP GET /openwiki/api/wikis/:id/status

request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::wikis-create

function

HTTP POST /openwiki/api/wikis

request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::wikis-list

function

HTTP GET /openwiki/api/wikis

request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::lint

function

Validate every page citation against the clone and flag thin pages.

request
  • idstringrequired
response
  • checkedintegerrequired
  • issuesobject[]required
    • detailstring
    • kindstringrequiredenum: broken-citation, orphan, missing-xref, stale, thin
    • slugstringrequired

openwiki::models

function

Models available via llm-router (for the UI's model picker), plus the configured default. Empty when no provider is configured.

request
empty object
response
  • default_modelstringrequired
  • modelsobject[]required
    • idstringrequired
    • providerstringrequired
    • supports_structured_outputboolean

openwiki::on-config-change

function

Reload runtime config when the openwiki configuration entry changes.

request
empty object
response
  • reloadedbooleanrequired

openwiki::on-turn-completed

function

Internal: routes harness::turn-completed events to the active generation.

request
empty object
response
valuenull

openwiki::on-turn-started

function

Internal: routes harness::turn-started events (sub-agent spawns) to the active generation.

request
empty object
response
valuenull

openwiki::page

function

Get a single wiki page (markdown body + metadata). Params: { id, slug } (slug from openwiki::pages).

request
  • idstringrequired
  • slugstringrequired
response
  • categorystring
  • citationsobject[]
    • end_lineinteger
    • notestring
    • pathstringrequired
    • start_lineinteger
    • urlstring
  • confidencestringenum: low, medium, high
  • generatorstringenum: harness, router, heuristic
  • last_updatedstring
  • markdownstringrequired
  • quality_issuesinteger
  • slugstringrequired
  • source_pathsstring[]
  • statusstringenum: current, needs-review, stale
  • titlestring

openwiki::pages

function

List all pages of a wiki. Params: { id }.

request
  • idstringrequired
response
  • pagesobject[]required
    • categorystringrequired
    • citationsobject[]
      • end_lineinteger
      • notestring
      • pathstringrequired
      • start_lineinteger
      • urlstring
    • confidencestringenum: low, medium, high
    • generatorstringenum: harness, router, heuristic
    • last_updatedstring
    • quality_issuesinteger
    • slugstringrequired
    • source_pathsstring[]
    • statusstringenum: current, needs-review, stale
    • titlestringrequired

openwiki::read-wiki-contents

function

MCP: read one wiki page (markdown + metadata).

request
  • idstringrequired
  • slugstringrequired
response
  • categorystring
  • citationsobject[]
    • end_lineinteger
    • notestring
    • pathstringrequired
    • start_lineinteger
    • urlstring
  • confidencestringenum: low, medium, high
  • generatorstringenum: harness, router, heuristic
  • last_updatedstring
  • markdownstringrequired
  • quality_issuesinteger
  • slugstringrequired
  • source_pathsstring[]
  • statusstringenum: current, needs-review, stale
  • titlestring

openwiki::read-wiki-structure

function

MCP: list a wiki's structure (categories + pages).

request
  • idstringrequired
response
  • categoriesobject[]
    • descriptionstring
    • idstringrequired
    • titlestring
  • pagesobject[]required
    • categorystring
    • slugstringrequired
    • titlestring
  • repostring
  • summarystring

openwiki::refresh

function

Pull the repo and regenerate only the pages whose source changed (incremental).

request
  • idstringrequired
response
  • changedobject[]
    • pathstringrequired
    • statusstringrequired
  • pages_affectedstring[]
  • refreshstringrequiredenum: regenerating, up_to_date, in_progress, error
  • wiki_idstringrequired

openwiki::search

function

Search pages of a wiki by keyword. Params: { id, q }.

request
  • idstringrequired
  • qstringrequired
response
  • resultsobject[]required
    • categorystring
    • matchedstring[]
    • scorenumberrequired
    • slugstringrequired
    • snippetstring
    • source_pathsstring[]
    • titlestring

openwiki::set-schedule

function

Set a wiki auto-refresh cadence: off | 3h | 6h | 12h | daily | weekly | a cron string. Params: { id, schedule }.

request
  • idstringrequired
  • schedulestringrequired
response
  • idstringrequired
  • okbooleanrequired
  • schedulestringrequired

openwiki::src::grep

function

Search file contents in a wiki's cloned repo. Params: { id, pattern, max? }.

request
  • idstringrequired
  • maxinteger
  • patternstringrequired
response
  • matchesobject[]required
    • lineintegerrequired
    • pathstringrequired
    • textstringrequired
  • truncatedboolean

openwiki::src::list

function

List files (path, language, priority) in a wiki's cloned repo. Params: { id, dir? }.

request
  • dirstring
  • idstringrequired
response
  • filesobject[]required
    • languagestring
    • pathstringrequired
    • priorityinteger
    • sizeinteger
  • truncatedboolean

openwiki::src::read

function

Read a file (optional 1-indexed line window) from a wiki's cloned repo. Params: { id, path, from?, to? }.

request
  • frominteger
  • idstringrequired
  • pathstringrequired
  • tointeger
response
  • contentstringrequired
  • frominteger
  • pathstringrequired
  • tointeger
  • total_linesinteger
  • truncatedboolean

openwiki::status

function

Poll generation status for a wiki id.

request
  • idstringrequired
response
  • errorstring
  • messagestring
  • phasestringrequiredenum: queued, cloning, inventorying, planning, generating, linting, …
  • progressnumberrequired
  • updated_atstring

openwiki::wiki

function

Fetch a single wiki's metadata.

request
  • idstringrequired
response
  • categoriesobject[]
    • descriptionstring
    • idstringrequired
    • titlestringrequired
  • category_countintegerrequired
  • commitstring
  • content_hashstring
  • created_atstring
  • generatingbooleanrequired
  • idstringrequired
  • last_refresh_atstring
  • modelstring
  • navigationobject[]
    empty object
  • page_countintegerrequired
  • refstring
  • refresh_schedulestring
  • repo_namestringrequired
  • repo_urlstringrequired
  • steerobject
  • summarystring
  • updated_atstring

openwiki::wikis

function

List all wikis generated by this worker.

request
empty object
response
  • wikisobject[]required
    • categoriesobject[]
      • descriptionstring
      • idstringrequired
      • titlestringrequired
    • category_countintegerrequired
    • commitstring
    • content_hashstring
    • created_atstring
    • generatingbooleanrequired
    • idstringrequired
    • last_refresh_atstring
    • modelstring
    • navigationobject[]
      empty object
    • page_countintegerrequired
    • refstring
    • refresh_schedulestring
    • repo_namestringrequired
    • repo_urlstringrequired
    • steerobject
    • summarystring
    • updated_atstring

openwiki::write-page

function

A page-writer sub-agent stores its finished page (markdown + metadata) for a generating wiki.

request
  • categorystring
  • citationsobject[]
    • end_lineinteger
    • notestring
    • pathstringrequired
    • start_lineinteger
  • idstringrequired
  • markdownstringrequired
  • slugstringrequired
  • source_pathsstring[]
  • titlestring
response
  • okbooleanrequired
  • slugstringrequired

triggers

0
no triggers registered