payplug-docs-mcp
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@payplug-docs-mcpsearch Payplug docs for how to handle refunds"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
payplug-docs-mcp
An unofficial MCP (Model Context Protocol) server that provides tools for browsing and searching Payplug's official documentation.
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.
Related MCP server: NicePay MCP Server
Installation
Requires Python 3.13+ and uv.
git clone https://github.com/hache/payplug-docs-mcp
cd payplug-docs-mcp
uv syncUsage
With OpenCode
Add the following to your OpenCode configuration:
{
"mcpServers": {
"payplug-docs": {
"command": "uv",
"args": [
"run",
"--directory",
"/path/to/payplug-docs-mcp",
"python",
"server.py"
]
}
}
}From the command line
uv run python server.pyAvailable tools
Tool | Description |
| Lists the Payplug documentation URLs known to the server |
| Fetches and converts a Payplug doc page to plain text |
| Searches across all pages and returns excerpts |
License
The source code of this project is licensed under the MIT License — see 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.
Available Tools
3 toolslist_payplug_docsA
List the official Payplug documentation pages known to this MCP.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden of behavioral disclosure. It clarifies the scope ('known to this MCP') and implies a read-only listing operation, but does not describe what the returned list contains (titles, URLs, counts) or any ordering behavior. This is adequate but minimal.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single, front-loaded sentence with no filler. Every word contributes to the tool's purpose and scope, making it a model of concise description.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple, no-parameter listing operation with an output schema available, the description is largely sufficient. It lacks any mention of relation to siblings, but the low complexity means this is a minor gap rather than a critical omission.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has zero parameters, so the baseline is 4. The description does not need to add parameter detail since none exist, and there is no ambiguity about invocation.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('List') and resource ('official Payplug documentation pages known to this MCP'), making the tool's basic function unambiguous. It does not explicitly differentiate from siblings, but the list/read/search distinction is easily inferred from the sibling names.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool rather than read_payplug_doc or search_payplug_docs. The description gives no context about use cases, exclusions, or alternative selection, so the agent must rely on sibling names alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
read_payplug_docA
Read an official Payplug documentation page.
Only URLs under https://docs.payplug.com/ are accepted.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the behavioral burden. It does disclose the key restriction (only docs.payplug.com URLs are accepted), but it doesn't describe behavior on invalid URLs, response format, or other side effects. For a read tool this is a reasonable but not rich disclosure.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences with no filler; the essential URL restriction is placed second and the purpose is front-loaded. Every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple one-parameter read tool with an output schema, the description is mostly complete: it states the operation and the URL constraint. It could add a pointer to the sibling tools for URL discovery, but that is not required for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 0% and the schema only says 'url' is a required string. The description adds the crucial constraint that only URLs under https://docs.payplug.com/ are accepted, which meaningfully clarifies the parameter's allowed value.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Read') and the resource ('an official Payplug documentation page'), and the URL restriction further scopes it. It doesn't explicitly name sibling tools, but the read verb naturally distinguishes it from search and list.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The URL constraint implies when the tool applies (only docs.payplug.com pages), but the description gives no explicit guidance about using search_payplug_docs or list_payplug_docs as alternatives. Usage context is only implied, not stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
search_payplug_docsA
Search the configured official Payplug documentation pages.
The search is intentionally simple and read-only. It fetches the configured documentation pages, converts them to plain text, ranks them by occurrences of the query terms, and returns excerpts from the best matches.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | ||
| max_results | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden. It discloses the read-only nature, simplicity, and detailed process: fetches configured pages, converts to plain text, ranks by occurrence, and returns excerpts. This gives the agent a clear model of expected behavior, though it does not cover errors or rate limits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences with no fluff. The core purpose is front-loaded, and the following sentences add useful behavior detail. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description adequately explains core behavior and read-only status, and an output schema exists to define return values. However, missing parameter semantics for max_results and lack of explicit sibling usage guidance make it only minimally complete for an agent to confidently invoke the tool in all relevant scenarios.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate. It refers to 'query terms', which indirectly explains the query parameter, but it never describes max_results, its purpose, or how it controls the number of returned excerpts. This leaves a notable parameter guidance gap.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states a specific verb and resource: 'Search the configured official Payplug documentation pages.' It also describes the search pipeline and return of excerpts, which differentiates it from sibling tools like read_payplug_doc and list_payplug_docs.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for finding relevant snippets via term ranking, and explicitly notes it is 'intentionally simple and read-only.' However, it never mentions when to prefer sibling tools such as read_payplug_doc for full content or list_payplug_docs for enumeration, leaving usage guidance implied rather than explicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
TDQS
Each tool has a clearly distinct purpose: reading a specific page, searching across pages, and listing known pages. There is no meaningful overlap or ambiguity between them.
All tool names follow a verb_noun pattern with the common 'payplug_doc' prefix. The only minor inconsistency is that 'read_payplug_doc' uses singular 'doc' while the other two use plural 'docs'.
Three tools is well-scoped for a documentation MCP. Each tool covers a necessary operation without redundancy or bloat.
The standard documentation access workflow is fully covered: list available docs, search within them, and read a specific page. There are no obvious missing operations for this domain.
Maintenance
Resources
Unclaimed servers have limited discoverability.
Looking for Admin?
If you are the server author, to access and configure the admin panel.
Related MCP Connectors
Search PayU docs, browse the payment integration catalog, and fetch production-ready code.
Search Checkout.com docs and API reference, plus manage payments, refunds, and payment links.
The documentation, as a tool your agent can call: 950+ AI-dev guides. Search + fetch tools.
Search the SiteGPT documentation: setup, features, API reference, troubleshooting.
Related MCP Servers
- AlicenseBqualityDmaintenanceEnables LLMs to search and retrieve OwlPay documentation directly through natural language queries. Accelerates system integration by providing instant access to OwlPay API documentation and guides.1MIT
- AlicenseBqualityDmaintenanceEnables developers to search and access NicePay payment API documentation, including endpoint details, code samples, and SDK method information through natural language queries.4MIT
- AlicenseNot gradedqualityDmaintenanceEnables searching and reading of PortOne documentation, including OpenAPI schemas and product guides, through the Model Context Protocol. It allows AI agents to easily access and integrate payment-related technical specifications into their workflows.22ISC
- FlicenseNot gradedqualityCmaintenanceEnables AI coding tools to search and retrieve Bootpay payment and commerce developer documentation, including integration guides and customer service manuals. It facilitates tasks such as payment linking, billing key issuance, and webhook configuration through natural language queries.2
Latest Blog Posts
- Who's Calling? MCP Hosts Are an Identity Blind Spot (And the Spec Knows It)By Om-Shree-0709 on .mcpAgent IdentityOAuth 2.1
- Your AI Chatbot Just Exposed Your CEO's Salary to an InternBy Om-Shree-0709 on .Agent IdentityMCP SecurityOAuth Delegation
- Why MCP Servers Need Execution Sandboxing (And Why Your Current Stack Isn't Enough)By Om-Shree-0709 on .Agentic AiPrompt InjectionWebAssembly
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/HacheDev/payplug-docs-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server