# payplug-docs-mcp

An unofficial MCP (Model Context Protocol) server that provides tools for
browsing and searching [Payplug's official documentation](https://docs.payplug.com/).

> **Disclaimer:** This is an independent, unofficial project and is not
> affiliated with, endorsed by, or maintained by Payplug.

## Features

- **list_payplug_docs** — List the known Payplug documentation pages.
- **read_payplug_doc** — Fetch and render a specific documentation page as
  plain text.
- **search_payplug_docs** — Search across all configured documentation pages
  and return ranked excerpts.

All documentation is fetched **live** from `https://docs.payplug.com/` at
runtime. No Payplug content is bundled, cached, or distributed with this
project.

## Installation

Requires Python 3.13+ and [uv](https://docs.astral.sh/uv/).

```bash
git clone https://github.com/hache/payplug-docs-mcp
cd payplug-docs-mcp
uv sync
```

## Usage

### With OpenCode

Add the following to your OpenCode configuration:

```json
{
  "mcpServers": {
    "payplug-docs": {
      "command": "uv",
      "args": [
        "run",
        "--directory",
        "/path/to/payplug-docs-mcp",
        "python",
        "server.py"
      ]
    }
  }
}
```

### From the command line

```bash
uv run python server.py
```

### Available tools

| Tool               | Description                                         |
|--------------------|-----------------------------------------------------|
| `list_payplug_docs` | Lists the Payplug documentation URLs known to the server |
| `read_payplug_doc`  | Fetches and converts a Payplug doc page to plain text |
| `search_payplug_docs` | Searches across all pages and returns excerpts     |

## License

The **source code** of this project is licensed under the MIT License — see
[LICENSE](LICENSE).

Payplug's documentation, trademarks, logos, and other third-party content are
**not** licensed under this project's MIT license. They remain the property of
their respective owners.