Skip to content

jaakla/merit_api

Repository files navigation

Merit Unofficial MCP Server

MCP server ja Pythoni SDK Merit Aktiva REST API jaoks. MCP server eksponeerib praegu 29 tööriista, 3 töövoo prompti ja 2 ressurssi. See on mõeldud töötama MCP klientidega nagu Claude Code, Codex CLI, Cursor, Windsurf, Cline, Gemini CLI ja sarnased tööriistad.

Aktiivne arendus. See projekt areneb endiselt. MCP kiht on kasutatav, kuid see ei ole veel täisfunktsionaalne raamatupidamise töövoosüsteem. Kontrolli iga kirjutava operatsiooni tulemust live-raamatupidamisandmete vastu enne selle usaldamist.

Vastutusest loobumine

See on eksperimentaalne ja mitteametlik projekt. See ei ole seotud Merit Aktivaga, selle poolt toetatud ega ametlikult kinnitatud.

Kasutad seda täielikult omal vastutusel. See tarkvara saab lugeda ja muuta live-raamatupidamisandmeid, sh kliente, hankijaid, artikleid, arveid, makseid, makse ja dimensioone. Autorid ei vastuta vigaste kannete, kustutatud kirjete ega muu kaudse kahju eest.

Seda tarkvara kasutades nõustud, et:

  • vastutad ise kõigi loodud või muudetud raamatupidamisandmete kontrollimise eest
  • peaksid enne tähtsate live-andmete vastu kasutamist põhjalikult testima
  • tegemist on eksperimentaalse tarkvaraga ilma igasuguse garantiita

Nõuded

  • Node.js 18+ npx wrapperi jaoks
  • Python 3.10+ peab olema masinas olemas

npm-pakett eemaldab vajaduse Pythoni sõltuvusi käsitsi paigaldada, kuid server ise on kirjutatud Pythonis, seega on lokaalne Python interpreter siiski vajalik.

API mandaadid

Server kasutab järgmisi keskkonnamuutujaid:

  • MERIT_API_ID
  • MERIT_API_KEY
  • MERIT_API_COUNTRY on valikuline, EE või PL, vaikimisi EE

Näide:

export MERIT_API_ID=your-api-id
export MERIT_API_KEY=your-api-key
export MERIT_API_COUNTRY=EE

Kui MERIT_API_ID või MERIT_API_KEY puudub, käivitub server seadistusrežiimis (aga mitte igas kliendis). Seadistusrežiimis:

  • get_setup_instructions jääb kättesaadavaks
  • avastusressursid jäävad kättesaadavaks
  • promptid jäävad kättesaadavaks
  • API-põhised tööriistad tagastavad seadistusjuhise ega kutsu Merit API-t

Seadistus

1. Lisa MCP server

Enamik AI assistente oskab selle sinu eest seadistada. Mõeldud paketikäsk on:

npx -y merit-unofficial-mcp

Kui eelistad käsitsi seadistada:

Claude Code:

claude mcp add merit-api -- npx -y merit-unofficial-mcp

Teised tööriistad JSON-konfiguratsiooniga:

{
  "mcpServers": {
    "merit-api": {
      "command": "npx",
      "args": ["-y", "merit-unofficial-mcp"],
      "env": {
        "MERIT_API_ID": "your-api-id-here",
        "MERIT_API_KEY": "your-api-key-here"
      }
    }
  }
}

Codex CLI TOML-konfiguratsiooniga:

[mcp_servers.merit-api]
command = "npx"
args = ["-y", "merit-unofficial-mcp"]

npm wrapper loob automaatselt privaatse virtualenv-i, paigaldab sinna kaasasolevad Pythoni alamprojektid ja käivitab MCP serveri. Tavakasutuse korral ei pea kasutaja pip install käske käsitsi jooksutama.

Tööriistade konfiguratsioonifailide asukohad
Tööriist Konfiguratsioonifail
Claude Code ~/.claude/settings.json või projekti .claude/settings.json
Codex CLI ~/.codex/config.toml
Gemini CLI ~/.gemini/settings.json
Cursor projekti .cursor/mcp.json
Windsurf ~/.codeium/windsurf/mcp_config.json
Cline VS Code seadetes cline.mcpServers all

2. Käsitsi Pythonist käivitamine

Kui töötad otse Pythoni keskkonnast ega kasuta npx, saab MCP serveri käivitada ka nii:

python3 -m merit_api_mcp

3. Käivitamine lähtekoodist

git clone https://github.com/jaakla/merit_api.git
cd merit_api
pip install -e ./merit_api
pip install -e ./mcp
python3 -m merit_api_mcp

Töövood (MCP promptid)

Server sisaldab praegu 3 sisseehitatud prompti:

Prompt Kirjeldus
setup-merit-api Selgitab, kuidas seadistada vajalikud keskkonnamuutujad ja server käivitada
create-sales-invoice Juhendab assistenti kliendi leidmisel ja müügiarve loomisel
find-or-create-customer Juhendab assistenti kliendi otsimisel ja loomisel

Ressursid

Ressurss Kirjeldus
merit://server/info Serveri metaandmed, seadistusrežiimi staatus, toetatud env muutujad ja hoiatus
merit://tools/catalog Tööriistade kataloog koos konsolideeritud tööriistade, nende action'ite ja nõutud väljadega

Tööriistade pind

MCP server eksponeerib kompaktset domeenipõhist pinda. Iga tööriist kasutab action välja, et valida konkreetne Merit'i workflow.

Read-only tööriistad:

  • merit_read_master_data
  • merit_read_sales
  • merit_read_purchases
  • merit_read_financial
  • merit_read_inventory
  • merit_read_reports

Mutating tööriistad:

  • merit_write_customers
  • merit_write_sales
  • merit_write_purchases
  • merit_write_financial

Kõigi tööriistade täielik action-kataloog on ressursis merit://tools/catalog.

Kasutusnäited

Kui MCP server on ühendatud, saad AI assistendiga suhelda loomulikus keeles.

Uuri põhiandmeid

"Näita kliente, mis vastavad nimele Acme"

Assistant peaks kasutama merit_read_master_data tööriista action'iga customers_list ja filters={"Name": "Acme"}.

Loo või uuenda klienti

"Loo uus klient Example OÜ"

Assistant peaks koostama kliendi payloadi ja kutsuma merit_write_customers tööriista action'iga customer_upsert.

Loo müügiarve

"Loo kliendile Acme müügiarve aprilli konsultatsiooniteenuse eest"

Assistant saab kasutada merit_read_master_data action'iga customers_list, vajadusel find-or-create-customer, ja seejärel merit_write_sales action'iga sales_invoice_create.

Uuri viiteandmeid

"Mis pangad, kulukohad, projektid ja maksud Merit'is olemas on?"

Assistant saab kasutada merit_read_master_data tööriista action'eid banks_list, cost_centers_list, projects_list ja taxes_list.

Kontrolli seadistuse seisu

"Kontrolli, kas Merit MCP server on õigesti seadistatud"

Assistant saab kasutada get_setup_instructions ja merit://server/info.

SDK kasutamine

See repository sisaldab ka eraldi Pythoni SDK projekti kataloogis merit_api/.

Näide:

from merit_api import MeritAPI

client = MeritAPI(api_id="YOUR_API_ID", api_key="YOUR_API_KEY")

customers = client.customers.get_list()
invoices = client.sales.get_invoices(
    PeriodStart="2024-01-01",
    PeriodEnd="2024-01-31",
)

SDK sisaldab praegu:

  • deterministlikku request body serialiseerimist signeerimiseks
  • seadistatavat timeouti ja retry käitumist
  • request/response logger hooke koos saladuste redaktsiooniga
  • valikulist idempotency headeri genereerimist
  • API taseme ärivea parsimist HTTP 200 vastustest

Uuendamine

Uuendamise viis sõltub sellest, kuidas serverit käivitad.

Kui kasutad npx

Kui sinu MCP konfiguratsioon kasutab npx -y merit-unofficial-mcp, piisab tavaliselt MCP serveri taaskäivitamisest või uuesti laadimisest. Järgmisel käivitamisel tõmbab npx viimase avaldatud versiooni.

Kui klient jääb kasutama vanemat cache'itud versiooni, sunni ühe korra värskendus:

npx -y merit-unofficial-mcp@latest

Seejärel taaskäivita MCP server oma kliendis.

Kui jooksutad lokaalsest checkout'ist

git pull
pip install -e ./merit_api
pip install -e ./mcp

Seejärel taaskäivita MCP server oma kliendis.

Arendus

See repository on jaotatud eraldi alamprojektideks:

  • merit_api/ SDK jaoks
  • mcp/ Pythoni MCP serveri jaoks
  • juure package.json npm wrapperi jaoks

SDK testid:

cd merit_api
python3 -m pytest -q

MCP testid:

cd mcp
python3 -m pytest -q

Kontrolli npm wrapperi tarballi:

npm pack --dry-run

SDK live integratsioonitestid on opt-in:

cd merit_api
MERIT_API_INTEGRATION_TEST=true python3 -m pytest -q

Hea teada

  • Praegune MCP server toetab ainult ühte ühendust korraga
  • Audit logi püsisalvestust veel ei ole
  • Dry-run kirjutusvooge veel ei ole
  • Dokumentide ingest'i või OCR töövookihti veel ei ole
  • MCP skeemid jäävad üldiseks seal, kus aluseks olev SDK on üldine
  • Juure npm-pakett on launcher-wrapper; päris Pythoni projektid asuvad merit_api/ ja mcp/

Litsents

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors