Vikunja tasks

io.github.yarenty由 GitHub 帳號 yarenty 發布v0.2.0更新於 Nov 3, 2026

面向 MCP 客戶端的 Vikunja 任務:列出並讀取任務和專案;使用 --writable 可修改它們。

AI 翻譯由 AI 模型根據下方的原文描述翻譯,可能有誤。

原文描述

Vikunja tasks for MCP clients: list and read tasks and projects; with --writable, change them.

已驗證STDIO僅桌面

概覽

Vikunja tasks 的本機 MCP 服務;無需登入;STDIO。

暫無 AI 概覽:以下資訊來自註冊中心條目和服務本身。

安裝

在 SourceWeft 中

  1. 開啟 儀表板中的 Vikunja tasks,將其新增到工作區。
  2. 為需要使用其工具的對話啟用該服務。

Desktop only,透過 STDIO。 STDIO 服務會啟動本機處理程序,因此需要 SourceWeft 桌面主機。

其他 MCP 客戶端

參照 儲存庫 中的啟動說明。

README

emperor-vikunja

[CI] [license] [Glama]

An MCP server for Vikunja, the open-source task manager. Let Claude, kowalski or any MCP client list, read, create and update your tasks, comment on them and see your projects.

Built on emperor-mcp (Emperor Profile P1.1):

  • Stateless Streamable HTTP at /mcp, plus stdio for desktop clients.
  • Your token is forwarded, never stored. Over HTTP each request brings its own Authorization: Bearer <token>; the server passes it to Vikunja and forgets it. There are no default or test tokens.
  • Framed output. Task text written by people (titles, descriptions, comments) reaches the model marked as messages for the user, never as instructions for the model.
  • Read-only unless you say otherwise. Started plain, the server offers only the three read tools; --writable (or VIKUNJA_WRITABLE=true) adds the three that change tasks.
  • Six annotated tools with compact definitions, a doctor subcommand, Markdown in and plain text out.
  • Clear auth failures. When Vikunja refuses the token, the MCP response over HTTP is a 401 or 403, so the client can ask for a new token.

Tools

ToolListedAnnotationsWhat it does
list_tasksalwaysread-onlyTasks sorted by priority, then due date. Filters: project (title or id), label, done (default false), due_before, search; limit up to 100 (default 50). Returns id, title, project, labels, assignees, priority, due, done.
get_taskalwaysread-onlyOne task by id: every field, the description as plain text (first 20 000 characters), and the 50 most recent comments with author and date (4 000 characters each).
create_taskwith --writablewrite, not idempotentproject, title, optional description (Markdown), labels, create_missing_labels, assignees (usernames), priority 0-5, due.
update_taskwith --writablewrite, destructive, idempotentid plus any of title, description, done, priority, due ("none" clears it), add_labels, remove_labels, create_missing_labels, add_assignees, remove_assignees, project (move).
commentwith --writablewrite, not idempotentAdd a Markdown comment to task id.
list_projectsalwaysread-onlyProjects (up to 100) with id, title, parent and number of open tasks.

Without --writable the write tools are not in the server at all: they are neither listed nor callable, so neither the model nor text it reads can reach them.

Every tool is marked open-world (it talks to a Vikunja that other people change). update_task is marked destructive because a new title or description replaces the old text, which Vikunja does not keep, and labels and assignees can be removed; it is idempotent because the same call twice leaves the task as one call did.

Labels are named by title. A label that does not exist is an error unless the call passes create_missing_labels: true, so a typo does not quietly add a new label. Assignees are usernames (exact, case-insensitive; a leading @ is fine). Names are checked before anything is written: a bad label or username leaves no half-made task.

Priority: 0 unset, 1 low, 2 medium, 3 high, 4 urgent, 5 do now. Dates: YYYY-MM-DD (read as 00:00 UTC) or ISO-8601; dates come back as RFC 3339, or null when unset.

Descriptions and comments are stored by Vikunja as HTML. What the model writes in Markdown is rendered to HTML on the way in (raw HTML in the Markdown is escaped, not passed through); HTML read back is rendered to plain text.

Install

From a release (Linux x86_64, macOS arm64 and x86_64, Windows x86_64): download the archive for your platform from Releases and put emperor-vikunja on your PATH.

From source (Rust 1.88 or newer):

bash
cargo install --git https://github.com/yarenty/emperor-vikunja

Get a token

In Vikunja open Settings > API Tokens > Create a token, pick an expiry date and tick these permissions (the minimum the six tools need with --writable):

GroupPermissions
projectsread_all, read_one
tasksread_all, read_one, create, update
tasks_commentsread_all, create
tasks_labelsread_all, create, delete
tasks_assigneesread_all, create, delete
labelsread_all, create (create only for create_missing_labels)
otheruser (lets doctor show whose token it is), users (assignees by username)

The server is read-only by default; for a read-only assistant give it a token with only the read_all / read_one permissions (and other: user for doctor).

Run

Local (stdio)

bash
export VIKUNJA_TOKEN=...            # from Settings > API Tokensemperor-vikunja serve --stdio --base-url https://vikunja.example.com              # read-onlyemperor-vikunja serve --stdio --base-url https://vikunja.example.com --writable   # also create, update, comment

Docker (stdio)

bash
docker build -t emperor-vikunja https://github.com/yarenty/emperor-vikunja.gitdocker run -i --rm -e VIKUNJA_URL=https://vikunja.example.com -e VIKUNJA_TOKEN emperor-vikunja# read-only by default; to create, update and comment add -e VIKUNJA_WRITABLE=true# (or --writable after the image name)

The image runs emperor-vikunja serve --stdio as a non-root user; the Vikunja address comes from VIKUNJA_URL.

Shared (HTTP)

bash
# --writable: the users of this server may create, update and comment; leave it out for read-onlyemperor-vikunja serve --base-url https://vikunja.example.com --bind 127.0.0.1:8034 --writable# MCP endpoint: http://127.0.0.1:8034/mcp   liveness: http://127.0.0.1:8034/health

Every MCP request must carry Authorization: Bearer <token>; each user brings their own. VIKUNJA_TOKEN is ignored in this mode, so one person's token can never answer another person's request. Tool discovery (tools/list) works without a token.

When Vikunja refuses the token (401) or the token may not do this (403), the MCP response carries that HTTP status (401 with WWW-Authenticate: Bearer error="invalid_token") and a JSON-RPC error with code -32040 and data.httpStatus. Over stdio the client gets the same JSON-RPC error.

Flags and headers

FlagEnvMeaning
--base-url <URL>VIKUNJA_URLVikunja address; https://host and https://host/api/v1 both work. Required with --stdio; optional over HTTP when requests send X-Upstream-Url.
--writableVIKUNJA_WRITABLEAlso serve create_task, update_task and comment. Without it the server is read-only: the write tools are not in the server, not just refused. From the environment true, 1, yes or on turns it on; unset, empty, false, 0, no or off leaves it off; anything else stops the server at start-up.
--read-onlyVIKUNJA_READ_ONLYDeprecated, no effect: read-only is the default. Still accepted so existing configurations start; a one-line note is logged. Given together with --writable, the server refuses to start.
--stdioSpeak MCP over stdin/stdout; the token comes from VIKUNJA_TOKEN.
--bind <ADDR>HTTP listen address (default 127.0.0.1:8034).
--allowed-host <HOST>Accept only this Host header (repeatable); off by default, for a validating proxy in front.
--allowed-origin <ORIGIN>Accept only this Origin (repeatable), e.g. https://app.example.com.
Request header (HTTP)Meaning
Authorization: Bearer <token>The caller's Vikunja API token. Required for every tool call.
X-Upstream-Url: <URL>The Vikunja instance for this request, overriding --base-url. Must be https; plain http is accepted only for a loopback host (localhost, 127.0.0.0/8, ::1).

With X-Upstream-Url one server can front several Vikunja instances. The server will then call whichever https host a client names, with that client's token; run it where outbound calls to arbitrary hosts are acceptable, or leave the header out at your proxy and rely on --base-url.

Logs go to stderr; RUST_LOG=debug for more. In production put the HTTP server behind a reverse proxy that terminates TLS (Emperor Profile E5).

Connect

Claude Desktop (claude_desktop_config.json):

--writable lets Claude create, update and comment; drop it for a read-only connection.

json
{  "mcpServers": {    "vikunja": {      "command": "emperor-vikunja",      "args": ["serve", "--stdio", "--base-url", "https://vikunja.example.com", "--writable"],      "env": { "VIKUNJA_TOKEN": "<your token>" }    }  }}

Claude Code:

bash
# stdio, read-only (the default)claude mcp add vikunja-ro --env VIKUNJA_TOKEN=<your token> -- \  emperor-vikunja serve --stdio --base-url https://vikunja.example.com# stdio, --writable: Claude may also create, update and commentclaude mcp add vikunja --env VIKUNJA_TOKEN=<your token> -- \  emperor-vikunja serve --stdio --base-url https://vikunja.example.com --writable# or against a running HTTP server (its own --writable decides what is listed)claude mcp add --transport http vikunja http://127.0.0.1:8034/mcp \  --header "Authorization: Bearer <your token>" \  --header "X-Upstream-Url: https://vikunja.example.com"

kowalski (config.toml):

toml
[[mcp.servers]]name = "vikunja"transport = "stdio"# --writable: the agent may create, update and comment; drop it for read-only.command = ["emperor-vikunja", "serve", "--stdio", "--base-url", "https://vikunja.example.com", "--writable"]# VIKUNJA_TOKEN is read from kowalski's environment.
# or over HTTP (the server's own --writable decides what is listed)[[mcp.servers]]name = "vikunja-http"transport = "http"url = "http://127.0.0.1:8034/mcp"headers = { Authorization = "Bearer <your token>", X-Upstream-Url = "https://vikunja.example.com" }

Doctor

emperor-vikunja doctor checks the setup before you start the server and exits 1 when something is broken, so scripts and container health checks can use it:

text
$ VIKUNJA_TOKEN=... emperor-vikunja doctor --base-url https://vikunja.example.comemperor-vikunja 0.2.0 doctor  [ok  ] base url        https://vikunja.example.com/  [ok  ] vikunja api     Vikunja v2.7.1  [ok  ] VIKUNJA_TOKEN   set (43 chars)  [ok  ] vikunja login   token works for user alice  [ok  ] mode            read-only: get_task, list_projects, list_tasks (pass --writable or VIKUNJA_WRITABLE=true for create_task, update_task, comment)  [ok  ] listen address  127.0.0.1:8034 is free  [ok  ] tool budget     3 of at most 8 toolsall good (0 warning(s))

It checks that the URL parses, GET /api/v1/info answers, the token is set (only its length is shown) and GET /api/v1/user accepts it, which tools the mode serves (three read tools by default, all six with --writable; a warning when the deprecated --read-only is given), the listen address is free (skipped with --stdio), and the tool count is within the emperor-mcp budget. Without VIKUNJA_TOKEN in HTTP mode the token line is a warning, because the token comes per request; with --stdio it is a failure. The same goes for --base-url: over HTTP its absence is a warning (requests must send X-Upstream-Url), with --stdio a failure.

Compatibility

Tested against Vikunja v2.7 (the vikunja/vikunja image). Tasks are listed through GET /tasks with Vikunja's filter syntax (done = false && project = 3 && labels in 5 && due_date < '...'); older releases that serve /tasks/all instead are picked up automatically, and every filter is applied again locally so results stay right even where the server ignores part of it.

Build and test

bash
cargo test                                               # unit, fake-Vikunja, MCP HTTP and stdio testscargo test --test live_vikunja -- --ignored --nocapture  # default and --writable against a real Vikunja in Docker

Links

License

Licensed under either of

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in emperor-vikunja by you shall be dual licensed as above, without any additional terms or conditions.

來源:README.md,提交 b1a0b7a

工具

0
SourceWeft 曾在隔離沙箱中以無憑證方式啟動該軟體包一次,以列出其工具,但未能完成:該軟體包類型無法在沙箱中執行。

版本歷史

1
  1. v0.2.0最新Nov 3, 2026

評分

已滿足適用檢查項的 50%

該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。

  • 近 30 天內可連通25 分

    請保持端點能夠回應 MCP 握手;SourceWeft 每 30 天探測一次。

  • 已宣告認證方式10 分

    請在註冊中心條目中宣告憑證請求標頭,或保持端點能夠回應探測,以便判定其認證方式。

  • 已列出工具15 分

    請讓伺服器在無憑證時回應 tools/list,或發布可在沙箱中無憑證啟動的軟體包。

  • 描述必需15 分
  • 圖示10 分
  • 文件15 分
  • 授權條款10 分