SimpleShop MCP

Read-only FastMCP server for SimpleShop accounting data.

This server exposes a small MCP tool surface for AI agents that need to audit SimpleShop documents, download document PDFs, inspect products, and review product sales exports before copying data into another accounting system.

It is intentionally read-only. It does not create, update, delete, pay, cancel, send, or mutate SimpleShop records.

Features

• Find SimpleShop documents across invoices, proformas, receipts, orders, tax documents, and related document types.

• Batch-download document PDFs, with per-document success/error results.

• Expose document PDFs as MCP resources: simpleshop://documents/{document_id}/pdf/{variant}.

• Find products through the SimpleShop product API.

• Fetch and normalize SimpleShop "who bought" product sales exports.

• Return metadata useful for accounting filters, including document types, product types, flags, payment methods, number series, and tags.

• Use one reusable HTTP client initialized through FastMCP lifespan dependency injection.

• Redact customer/buyer PII by default, with explicit opt-in for full data.

Tool Surface

simpleshop_find_documents
simpleshop_download_documents
simpleshop_find_products
simpleshop_get_product_sales
simpleshop_get_metadata

Finder tools use a concrete query object with a required mode field:

{
  "query": {
    "mode": "search"
  }
}

or:

{
  "query": {
    "mode": "by_ids",
    "ids": [123]
  }
}

by_ids mode requires IDs and ignores stray search filters so retry calls remain robust when an agent carries over defaults from schema discovery.

See TOOLS.md for full schemas, examples, cursor behavior, and privacy controls. The design rationale is in DESIGN.md.

Privacy Defaults

Normal document and sales responses redact customer/buyer PII by default.

Set include_customer_pii: true only when the caller actually needs names, emails, phone numbers, addresses, company IDs, VAT IDs, custom sales fields, raw document payloads, or raw CSV exports.

Raw fields are guarded:

• include_raw requires include_customer_pii: true.

• include_raw_csv requires include_customer_pii: true.

• simpleshop_get_product_sales supports max_sales_rows, total_rows, returned_rows, and truncated for bounded exports.

Requirements

• Python >=3.13,<3.14

• uv

• Optional: mise for pinned local tool versions

The project currently pins:

• fastmcp==3.3.0

• httpx==0.28.1

• pydantic==2.13.4

• pydantic-settings==2.14.1

Installation

Using mise:

mise install
mise run sync

Using uv directly:

uv sync --locked

Configuration

Create a local .env from the example or set the variables in your MCP host environment:

cp .env.example .env

Required:

SIMPLESHOP_LOGIN=user@example.com
SIMPLESHOP_API_KEY=replace-with-api-key

Optional:

SIMPLESHOP_BASE_URL=https://api.simpleshop.cz/2.0/
SIMPLESHOP_TIMEOUT_SECONDS=30

Do not commit .env or real API credentials.

Running

Run the MCP server over stdio:

uv run --locked simpleshop-mcp

With the installed script:

uv run --locked simpleshop-mcp

Run directly from GitHub with uvx:

SIMPLESHOP_LOGIN=user@example.com \
SIMPLESHOP_API_KEY=replace-with-api-key \
uvx --from git+https://github.com/mikz/simpleshop-mcp.git simpleshop-mcp

For local development with FastMCP reload:

mise run mcp

MCP Client Configuration

Example MCP server config:

[mcp_servers.simpleshop]
command = "uv"
args = ["run", "--locked", "simpleshop-mcp"]
cwd = "/path/to/simpleshop-mcp"

If you use mise:

[mcp_servers.simpleshop]
command = "mise"
args = ["run", "mcp"]
cwd = "/path/to/simpleshop-mcp"

Run from GitHub without cloning:

[mcp_servers.simpleshop]
command = "uvx"
args = ["--from", "git+https://github.com/mikz/simpleshop-mcp.git", "simpleshop-mcp"]

Pass credentials through your MCP host environment, not through committed config.

Development

Run tests:

uv run --locked pytest

Run lint:

uv run --locked ruff check .

Check formatting on touched files:

uv run --locked ruff format --check src tests

Live smoke tests are intentionally opt-in because they use real SimpleShop credentials and may expose account data in local logs if run carelessly. See E2E.md.

Repository Layout

src/
  client.py        SimpleShop HTTP client
  models.py        Pydantic models for normalized and raw API data
  normalization.py Document normalization helpers
  server.py        FastMCP server and exposed tools
DESIGN.md          Tool design rationale
TOOLS.md           Tool reference and examples
E2E.md             Live smoke-test guidance
tests/             Offline unit and contract tests

License

MIT. See LICENSE.