Skip to main content

confluence-knowledge (local MCP service)

Local companion service for the confluence-knowledge Copilot agent. See ../../docs/confluence-knowledge.md for the full guide.

  • GET-only ConfluenceClient — non-GET raises SecurityException pre-flight.
  • Recursive subtree crawl (Cloud v2 + Data Center), resumable.
  • Local embeddings (all-MiniLM-L6-v2) + local reranker (ms-marco-MiniLM-L6-v2) — Apache-2.0, pinned in models.lock.json, never a cloud embedding call.
  • SQLite + FTS5 + vector-blob index under .conf_knowledge_index/.
  • Credentials via OS keyring / env var / chmod-600 .conf_auth.json.

Dev

python3.11+ -m venv .venv && .venv/bin/pip install -e '.[dev]'
.venv/bin/python -m pytest        # all offline — no network needed
.venv/bin/python -m ruff check src tests

Before every release, run the end-to-end smoke test. It spawns the real stdio server through the MCP client SDK and uses the real models against a fake Confluence on localhost, with simulated network latency:

.venv/bin/pip install -e '.[models]'
CONF_KNOWLEDGE_HOME=/tmp/ck/home .venv/bin/confluence-knowledge prepare-models
CONF_KNOWLEDGE_HOME=/tmp/ck/home .venv/bin/python scripts/e2e_smoke.py   # ends with "E2E OK"

e2e_bootstrap.py goes further — it replays the agent's entire install flow in a sandboxed $HOME (python discovery → venv → pip install from the shipped dist/ bundle → models → credentials → register → the real server over stdio → a full Q&A round-trip). Run it before every release:

CK_MODEL_CACHE=/tmp/ck/home/models .venv/bin/python scripts/e2e_bootstrap.py  # "E2E BOOTSTRAP OK"

CLI

Command Purpose
confluence-knowledge setup guided env/site/token setup (hidden input, keyring)
confluence-knowledge prepare-models fetch pinned local models once
confluence-knowledge doctor verify config + heartbeat + models
confluence-knowledge serve run the stdio MCP server (what the IDE launches)
confluence-knowledge clean delete the local index (~/.confluence-knowledge/work unless CONF_KNOWLEDGE_WORKDIR is set)

Metadata

Release files for confluence-knowledge 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for confluence-knowledge 0.3.1
File Size Uploaded
confluence_knowledge-0.3.1.tar.gz 35.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for confluence-knowledge 0.3.1
File Interpreter ABI Platform
confluence_knowledge-0.3.1-py3-none-any.whl Python 3 none any Details

Total release size: 65.8 kB

Release files / confluence_knowledge-0.3.1.tar.gz

Download URL confluence_knowledge-0.3.1.tar.gz
Size 35.8 kB
Tags Source
SHA-256 checksum
How to use checksums
45e160981219ff5e0b0972548d91e260397d7e836a94fcb41f7ffcec0cb30992
BLAKE2b-256 checksum
How to use checksums
41887a6823859bb17f5ae71b01a56ee5c3565ecfdf652d73bf38dead882ef62e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / confluence_knowledge-0.3.1-py3-none-any.whl

Download URL confluence_knowledge-0.3.1-py3-none-any.whl
Size 30.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b9a066f07cc2fc700aa7682ddfce0abca5e5130bd5d83d3d39343252d3f4185b
BLAKE2b-256 checksum
How to use checksums
20ef27ba141f7aff9f43839f8a466e14f24739dd26214869c9dc25721b156f0a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release history Release notifications | RSS feed

0.5.1

2 release files

0.5.0

2 release files

0.4.1

2 release files

0.4.0

2 release files

This release

0.3.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page