ksef-mcp
Lokalny serwer MCP do KSeF (Krajowy System e-Faktur), zbudowany przez Dev10x.Guru.
Uruchamiany na własnej maszynie przez uvx ksef-mcp — dane faktur nie
przechodzą przez żadną usługę pośredniczącą.
Strona projektu: ksef.dev10x.guru
Stan projektu
Serwer MCP wystawia dziś sześć narzędzi: server_info,
synchronise_invoices, list_recent_invoices, export_period_statement,
review_new_invoices i render_invoice_pdf — patrz sekcja
Narzędzia MCP niżej. Wszystko, co poniżej oznaczono jako
🚧 planowane, jeszcze nie istnieje w kodzie — opisujemy to, żeby kierunek był
jawny, nie żeby sugerować gotowość.
| Obszar | Stan |
|---|---|
Pakiet, uruchamianie przez uvx, testy |
✅ działa |
Konfiguracja: onboarding, doctor, token |
✅ działa |
Potwierdzenie połączenia: verify |
✅ działa |
| Synchronizacja i przegląd faktur zakupowych | ✅ działa |
| Wyszukiwanie i pobieranie faktur sprzedażowych | 🚧 planowane |
| Wizualizacja PDF | ✅ działa, wymaga Node |
Narzędzia MCP
| Narzędzie | Co robi | Sięga do KSeF |
|---|---|---|
server_info |
zwraca nazwę i wersję działającego serwera | nie |
synchronise_invoices |
pobiera, odszyfrowuje i archiwizuje paczki faktur zakończone przez KSeF od ostatniego uruchomienia | tak |
list_recent_invoices |
listuje metadane faktur z ostatnich trzydziestu dni, wg typu podmiotu | nie |
export_period_statement |
zapisuje faktury zakupowe za wybrany miesiąc jako CSV do przekazania księgowej | nie |
review_new_invoices |
pokazuje faktury, które przyszły od ostatniego przeglądu — czego nie potrafi darmowa aplikacja Ministerstwa | nie |
render_invoice_pdf |
zapisuje już zarchiwizowaną fakturę jako PDF, bez sięgania do sieci | nie |
synchronise_invoices jest jedynym narzędziem z tej listy, które wydaje
godzinowy budżet zapytań do KSeF. Pozostałe pracują na danych już
zarchiwizowanych lokalnie.
Co ten projekt robi
MVP jest wąski i celowo: znajdź faktury za wybrany miesiąc i pobierz je.
Mapa drogowa ma trzy etapy:
- jeden podmiot, faktury zakupowe, wyłącznie odczyt,
- ten sam podmiot, faktury sprzedażowe,
- biura rachunkowe z przełączaniem podmiotów.
Poza zakresem: wysyłka faktur, korekty, zarządzanie uprawnieniami. To nie jest zapomniane — to jest świadomie niezbudowane.
Dla kogo
Odbiorcą jest użytkownik techniczny. Instalacja wymaga terminala i menedżera wersji; w kliencie innym niż Claude Code także ręcznej edycji jego pliku konfiguracyjnego. Nie udajemy, że jest to instalacja dla osoby nietechnicznej — dystrybucja dla takiego odbiorcy (instalator albo rozszerzenie do klienta) to osobny, przyszły etap.
Wymagania wstępne
Python 3.13.14 — przypięty dokładnie, nie zakresem (.python-version oraz
requires-python w pyproject.toml). uv pobierze ten interpreter sam, więc nie
trzeba instalować go ręcznie.
Zasada obowiązuje w całym projekcie: przypinamy konkretne wersje, nigdy zakresy —
także zależności. Rozjazd interpretera pociąga rozjazd rozwiązanych wersji
bibliotek, a uvx i tak rozwiązuje wersję za nas.
Node 22.17.0 przez fnm — potrzebny wyłącznie do generowania PDF-ów.
winget install Schniz.fnm # Windows
⚠️ Sama obecność pliku .node-version nie wystarczy. Automatyczne przełączanie
wersji wymaga fnm env w profilu powłoki — bez tego plik jest deklaracją bez
egzekucji i można pracować na innej wersji Node, nie wiedząc o tym.
Bez Node narzędzie działa i oddaje XML, CSV oraz listę faktur. Traci wyłącznie PDF. To degradacja, nie awaria.
Instalacja i uruchomienie
Jedyny krok do świadomego wykonania to jedna komenda:
uvx ksef-mcp onboarding
Przeprowadzi po kolei przez wszystko, co trzeba ustalić przed pierwszym uruchomieniem, i można ją uruchamiać wielokrotnie — poprawia to, co już zapisano, zamiast dokładać drugi wpis:
- sprawdza warunki wstępne: Python, Node (tylko do PDF-ów) i magazyn keyringu, w którym zamieszka token;
- pyta o NIP podmiotu, magazyn tokenu i środowisko KSeF — domyślnie testowe, nigdy produkcyjne bez wyraźnego wyboru;
- prosi o wklejenie tokena KSeF (bez echa) i zapisuje go w keyringu;
- pyta o katalog roboczy na zestawienia i PDF-y i mówi, gdzie naprawdę ląduje archiwum XML — ten katalog obejmuje się kopią zapasową;
- rejestruje serwer w Claude Code (
claude mcp add) i proponuje instalację skilla, który uczy agenta korzystać z narzędzi; - na koniec proponuje
verify— domyślnie nie, bo to jedyny krok, który sięga do KSeF i wydaje godzinowy budżet.
Serwer komunikuje się przez stdio i jest uruchamiany przez klienta MCP, nie
ręcznie. Pliku konfiguracyjnego klienta nie trzeba edytować — onboarding
robi to za Ciebie, gdy na maszynie jest komenda claude.
Ścieżka awaryjna: klient bez komendy claude
Gdy klient MCP to nie Claude Code (albo claude nie ma na PATH),
onboarding pomija rejestrację i pokazuje, co wpisać ręcznie. Wpis w pliku
klienta (.mcp.json, claude_desktop_config.json) wygląda tak:
{
"mcpServers": {
"ksef": {
"command": "uvx",
"args": ["ksef-mcp"]
}
}
}
Reszta konfiguracji — NIP, token, środowisko, katalog roboczy — i tak pochodzi z onboardingu; sam wpis w kliencie tylko uruchamia serwer.
Dla współtwórcy: wersja z katalogu roboczego
Instalując z PyPI, tego wariantu nie potrzebujesz. Służy do uruchamiania kodu z lokalnego klonu zamiast opublikowanej wersji:
{
"mcpServers": {
"ksef": {
"command": "uvx",
"args": ["--from", "/ścieżka/do/ksef-mcp", "ksef-mcp"]
}
}
}
Komendy
| Komenda | Co robi | Sięga do KSeF |
|---|---|---|
ksef-mcp |
uruchamia serwer MCP na stdio | nie |
ksef-mcp onboarding |
konfiguracja przed pierwszym uruchomieniem | nie |
ksef-mcp doctor |
same warunki wstępne | nie |
ksef-mcp token set|delete|status |
token w keyringu | nie |
ksef-mcp skill install --scope user|project |
uczy agenta, jak używać serwera | nie |
ksef-mcp purge |
kasuje faktury z archiwum, zachowując indeks deduplikacji | nie |
ksef-mcp verify |
potwierdza połączenie i pokazuje ostatnie faktury | tak |
purge jest bezpiecznikiem bezterminowej retencji: archiwum nie wygasa samo,
więc czyszczenie odbywa się jawną komendą. Ciąć można po podmiocie (--nip,
domyślnie ten z konfiguracji), po dacie wpływu do KSeF (--od, --do) albo po
obu naraz. Zanim cokolwiek zniknie, komenda wypisuje numery KSeF do skasowania
i pyta o zgodę — domyślnie odmawia. Indeks deduplikacji zostaje nietknięty,
więc ponowna synchronizacja nie ściąga skasowanych faktur powtórnie; nietknięte
zostają też punkty kontynuacji i zapis tego, co już przejrzano. Każde
skasowanie zostawia wpis w dzienniku audytu.
skill install zapisuje skill dla Claude Code: przy zakresie user do
~/.claude/skills/ksef-mcp/, przy project do ./.claude/skills/ksef-mcp/
w katalogu wywołania. Zakresu nie przyjmuję domyślnie — uvx bywa uruchamiany
z przypadkowego miejsca, więc cicho wybrany katalog byłby ostatnim, w którym
ktokolwiek szukałby pliku. Komenda instaluje i aktualizuje: gdy skill już jest
i różni się od nowego, pokazuje różnicę i pyta, zanim cokolwiek nadpisze —
cudze zmiany nie znikają bez pokazania ich.
Na maszynie bez magazynu keyringu (headless, WSL, kontener) tokenu nie da się
zapisać. Ścieżką awaryjną jest zmienna KSEF_TOKEN — gdy jest ustawiona,
ma pierwszeństwo przed keyringiem, a ksef-mcp token status powie, z którego
źródła token pochodzi. Pierwszeństwo jest celowe: kto ją eksportuje, robi to
świadomie, a ciche preferowanie keyringu wyglądałoby na zignorowanie eksportu.
Osobnym przypadkiem jest magazyn obecny, ale zablokowany — po uśpieniu
maszyny albo po upływie własnego czasu magazynu. Każda komenda dotykająca
tokenu sprawdza wtedy stan blokady i przerywa z instrukcją zamiast otwierać
okno z prośbą o hasło. Takie okno otwiera się w środku czynności wyglądającej
na zwykły odczyt i zawiesza rozmowę z agentem, bo serwer MCP na stdio nie ma
gdzie go pokazać. Stan blokady pokazuje też ksef-mcp doctor.
verify jest osobną komendą, a nie ostatnim krokiem onboardingu, celowo.
Onboarding uruchamia się wielokrotnie przy poprawianiu konfiguracji, a każde
zapytanie do KSeF zjada godzinowy budżet, którego przekroczenia Ministerstwo
Finansów rejestruje. Budżet wydajemy wtedy, gdy prosisz o to świadomie.
Gdy KSeF odmówi z powodu limitu, verify wypisze czas oczekiwania i nie
ponowi zapytania samoczynnie. Wbudowane ponawianie w ksef2 jest z tego
samego powodu ograniczone do jednej próby: jego okno wynosi cztery sekundy,
a rzeczywisty Retry-After bywa liczony w minutach, więc pętla nie doczeka
końca limitu — doda tylko prób do wzorca wyglądającego na jego obchodzenie.
Wizualizacja PDF
Narzędzie MCP render_invoice_pdf bierze numer KSeF faktury już leżącej
w archiwum i zapisuje ją jako PDF w katalogu roboczym. Nic nie pobiera:
nie zużywa godzinowego budżetu zapytań i działa bez sieci. Faktura, której
jeszcze nie zsynchronizowano, jest odmawiana, a nie dociągana.
PDF-y generuje oficjalny generator Ministerstwa Finansów
(@akmf/ksef-fe-invoice-converter, licencja MIT), zwendorowany w
src/ksef_mcp/rendering/vendor/. Wynik jest tożsamy z tym, co daje portal MF — zweryfikowane
uruchomieniem, nie tylko lekturą kodu. Dokument niesie kod QR, link weryfikacyjny
i numer KSeF.
Bundel nie pochodzi z rejestru npm — paczki o tej nazwie tam nie ma.
Serwuje go portal weryfikacyjny MF pod /client-app/pdf-lib/; szczegóły
i suma kontrolna w
src/ksef_mcp/rendering/vendor/LICENCJA-MF.md.
Link weryfikacyjny trafia wyłącznie na dokumenty produkcyjne. Środowiska TEST i DEMO nie mają powierzchni weryfikacyjnej, więc PDF stamtąd nie niesie odsyłacza prowadzącego donikąd.
Generator obsługuje FA(1), FA(2), FA(3), UPO i PEF, ale przetestowaliśmy wyłącznie FA(3). Pozostałe schematy traktujemy jako niepotwierdzone.
Bezpieczeństwo danych
Token KSeF nie powinien trafiać do pliku konfiguracyjnego klienta MCP — te pliki są zwykłym tekstem na dysku. Docelowo serwer będzie czytał poświadczenia z keyringu systemowego.
Domyślnym środowiskiem jest TEST. Produkcja wymaga świadomego włączenia.
Limity zapytań
API KSeF ogranicza liczbę zapytań o metadane. Krążące wartości to 8/s, 16/min i 20/h, ale nie potwierdziliśmy ich — nie opierajcie na nich planowania, dopóki nie zostaną zweryfikowane wobec dokumentacji MF.
Rozwój
make help wypisuje wszystkie dostępne komendy.
make install # uv sync --group dev
make hooks # instalacja hooków pre-commit i commit-msg
make test # uv run pytest z pokryciem
make lint # pre-commit na całym drzewie
make coverage-report # testy + otwarcie raportu HTML
make upgrade-requirements # uv lock --upgrade
make build-requirements # eksport do requirements/*.txt
Linting i formatowanie idą wyłącznie przez pre-commit — to ta sama ścieżka, która blokuje commit, więc lokalny przebieg nie rozjeżdża się z hookiem.
Pokrycie testami jest egzekwowane na poziomie 100% (fail_under w pyproject.toml),
więc lokalny przebieg i CI stosują identyczny próg.
Licencje
Projekt jest na licencji AGPL-3.0-only — pełny tekst w pliku LICENSE.
Zwendorowany generator PDF Ministerstwa Finansów jest osobnym artefaktem na
licencji MIT. Jego nota licencyjna leży obok niego —
src/ksef_mcp/rendering/vendor/LICENCJA-MF.md
— i dotyczy wyłącznie tego pliku, nie reszty projektu.
To nie jest ksef-mcp.pl
Istnieje niepowiązany z nami projekt o tej samej nazwie, wystawiony jako
zdalny serwer MCP pod https://ksef-mcp.pl/mcp (HTTP + OAuth). Różnica jest
zasadnicza, nie kosmetyczna: tam faktury i uwierzytelnienie przechodzą przez
cudzą usługę, tutaj nie opuszczają Twojej maszyny. Jeśli Twój klient MCP
wystawił Ci adres autoryzacyjny w przeglądarce — to nie był ten serwer. Nasz
uruchamia się lokalnie przez uvx ksef-mcp i o nic nie pyta w przeglądarce.
Obie dystrybucje instalują skrypt konsolowy o nazwie ksef-mcp, więc przy
obu zainstalowanych wygrywa ta wcześniejsza w PATH. Sprawdzisz, co masz,
przez ksef-mcp doctor [#75].
Release files for ksef-mcp 0.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ksef_mcp-0.4.1.tar.gz | 1.6 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ksef_mcp-0.4.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 2.7 MB
Release files / ksef_mcp-0.4.1.tar.gz
| Download URL | ksef_mcp-0.4.1.tar.gz |
|---|---|
| Size | 1.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7a159e39cd4e185f2c90d013640bb98511e44744a69527d48f69cd7088138d85
|
|
BLAKE2b-256 checksum How to use checksums |
5ac1bbd1a62890bd3087a1a8eeae4b9ca171723ab0ce769cfd3b270cf47b9a25
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 26, 2026.
Transparency logRelease files / ksef_mcp-0.4.1-py3-none-any.whl
| Download URL | ksef_mcp-0.4.1-py3-none-any.whl |
|---|---|
| Size | 1.2 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
eceb1b70e514943acbbf9f84a44130f1326e30cc9db2630f6177ede324f7d072
|
|
BLAKE2b-256 checksum How to use checksums |
57fec798478f9a5539a24b4f0a8a382d7cf26408bae1c8fc3275f36690bc8dde
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 26, 2026.
Transparency log