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 ONNX embeddings (bge-m3, quantized) + sparse leg (Qdrant/bm25)
    • reranker (bge-reranker-v2-m3, quantized) — MIT/Apache-2.0, pinned in models.lock.json, no torch, 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.5.0

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.5.0
File Size Uploaded
confluence_knowledge-0.5.0.tar.gz 44.5 kB Details

Built distribution (wheel)

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

Total release size: 82.3 kB

Release files / confluence_knowledge-0.5.0.tar.gz

Download URL confluence_knowledge-0.5.0.tar.gz
Size 44.5 kB
Tags Source
SHA-256 checksum
How to use checksums
c6f43fde7dc69d26afa163774d47eef65a8bc0c61b40bd55f6ff5645a0819fda
BLAKE2b-256 checksum
How to use checksums
75befa739aa29aabd3a29eddd37fa412bcd0ad30471f6638fbd5cd808380ca2a
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.5.0-py3-none-any.whl

Download URL confluence_knowledge-0.5.0-py3-none-any.whl
Size 37.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
de844fa11746146ccbbbf26001e67fcf6860efb40c86fb9af34228be9ab72fd3
BLAKE2b-256 checksum
How to use checksums
fd2b94bb931506dc2a95770a58a9eda7a405783a4d5734fd7d7f55418bd3e6d3
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

This release

0.5.0 This release

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.1

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