yop-mcp
Click on "Deploy 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., "@yop-mcpshow me the overview of YOP platform"
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.
YOP MCP Server
🚀 快速对接易宝支付开放平台(YOP)的 MCP Server
📖 简介
yop-mcp 是一个专为易宝支付开放平台(YOP)设计的 MCP (Model Context Protocol) Server,提供了一套完整的工具函数,帮助开发者通过AI助手(如Claude、Cursor等)更便捷地获取YOP平台的相关信息、生成密钥对、下载证书等操作。
✨ 核心特性
🔧 10个专业工具函数 - 覆盖平台概览、产品详情、API文档、SDK指南等
🔐 密钥管理 - 支持RSA/SM2算法的密钥对生成和证书下载
📚 智能文档获取 - 自动获取最新的API文档和产品信息
🛡️ 安全可靠 - 内置容错机制和安全验证
🚀 即插即用 - 与主流AI开发工具无缝集成
Related MCP server: Yapi Auto MCP Server
🛠️ 功能特点
该 MCP Server 提供以下工具函数:
📋 平台信息获取
yeepay_yop_overview() - 获取易宝支付开放平台(YOP)的平台规范、产品概览、接入流程和对接工具信息
yeepay_yop_product_overview() - 获取易宝支付开放平台(YOP)的所有产品的概览信息
yeepay_yop_product_detail_and_associated_apis(product_code) - 获取指定产品的介绍、使用说明和相关 API 接口列表
yeepay_yop_api_detail(api_uri) - 获取指定 API 接口的详细定义,包括基本信息、请求参数、响应参数、示例代码等
📚 文档和SDK指南
yeepay_yop_java_sdk_user_guide() - 获取易宝支付开放平台(YOP)的 yop-java-sdk 使用说明
yeepay_yop_sdk_and_tools_guide() - 获取易宝支付开放平台(YOP)提供的各种SDK和工具的使用说明
yeepay_yop_link_detail(url) - 获取易宝支付开放平台(YOP)的各个子页面或外部链接的详细内容
🔐 密钥和证书管理
yeepay_yop_gen_key_pair(algorithm, format, storage_type) - 生成非对称加密的密钥对
yeepay_yop_download_cert(algorithm, serial_no, auth_code, private_key, public_key, pwd) - 下载CFCA证书
yeepay_yop_parse_certificates(algorithm, pfxCert, pubCert, pwd) - 解析证书文件获取公钥或私钥字符串
📋 环境要求
Python: 3.10 或更高版本
包管理器: uv(推荐)或 pip
操作系统: Windows / macOS / Linux
🚀 快速开始
方式一:直接使用 uvx(推荐)
1. 安装 uv
Windows:
pip install uvLinux/Mac:
curl -LsSf https://astral.sh/uv/install.sh | sh2. 直接运行
uvx yop-mcp这将自动从 PyPI 下载并运行最新版本的 yop-mcp。
方式二:从源码安装
1. 获取代码
git clone http://gitlab.yeepay.com/yop/yop-mcp.git
cd yop-mcp2. 安装依赖
uv sync # 这将创建虚拟环境并安装所需的包3. 运行服务器
uv run yop_mcp/main.py服务器启动后,您将看到类似以下的输出:
MCP Server started on stdio transport🔧 在 AI 工具中配置
方式一:使用 uvx(推荐)
Cursor 配置
{
"mcpServers": {
"yop-mcp": {
"command": "uvx",
"args": ["yop-mcp"],
"timeout": 600,
"autoApprove": [
"yeepay_yop_overview",
"yeepay_yop_product_overview",
"yeepay_yop_product_detail_and_associated_apis",
"yeepay_yop_api_detail",
"yeepay_yop_java_sdk_user_guide",
"yeepay_yop_sdk_and_tools_guide",
"yeepay_yop_link_detail",
"yeepay_yop_gen_key_pair",
"yeepay_yop_download_cert",
"yeepay_yop_parse_certificates"
]
}
}
}Claude Desktop 配置
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"yop-mcp": {
"command": "uvx",
"args": ["yop-mcp"]
}
}
}方式二:从源码运行
如果您选择从源码安装,请使用以下配置:
Cursor 配置
请记得将路径 /Users/your-username/path/to/yop-mcp 更改为您系统上实际克隆仓库的路径。
{
"mcpServers": {
"yop-mcp": {
"command": "uv",
"args": [
"--directory",
"/Users/your-username/path/to/yop-mcp",
"run",
"yop_mcp/main.py"
],
"timeout": 600,
"autoApprove": [
"yeepay_yop_overview",
"yeepay_yop_product_overview",
"yeepay_yop_product_detail_and_associated_apis",
"yeepay_yop_api_detail",
"yeepay_yop_java_sdk_user_guide",
"yeepay_yop_sdk_and_tools_guide",
"yeepay_yop_link_detail",
"yeepay_yop_gen_key_pair",
"yeepay_yop_download_cert",
"yeepay_yop_parse_certificates"
]
}
}
}Claude Desktop 配置
{
"mcpServers": {
"yop-mcp": {
"command": "uv",
"args": ["--directory", "/path/to/yop-mcp", "run", "yop_mcp/main.py"]
}
}
}📚 API 文档
1. yeepay_yop_overview()
获取易宝支付开放平台(YOP)的概览信息,包括平台规范、产品概览、接入流程和对接工具等信息。
示例调用:
yeepay_yop_overview()返回: YOP 平台概览信息(markdown 格式)
2. yeepay_yop_product_overview()
获取易宝支付开放平台(YOP)的所有产品的概览信息。
示例调用:
yeepay_yop_product_overview()返回: YOP 平台所有产品的概览信息(markdown 格式)
3. yeepay_yop_product_detail_and_associated_apis(product_code)
获取指定产品的介绍、使用说明和相关 API 接口列表。
参数:
product_code(字符串)- 产品编码,产品的唯一标识
示例调用:
yeepay_yop_product_detail_and_associated_apis("user-scan")返回: 指定产品的介绍、使用说明和相关 API 接口列表(markdown 格式)
4. yeepay_yop_api_detail(api_uri)
获取指定 API 接口的详细定义,包含基本信息、请求参数、请求示例、响应参数、响应示例、错误码、回调、示例代码等信息。
参数:
api_uri(字符串)- API 的 URI 路径,支持以下格式:/rest/v1.0/aggpay/pre-payhttps://open.yeepay.com/docs-v3/api/post_rest_v1.0_aggpay_pre-pay.mdhttps://open.yeepay.com/docs-v2/apis/user-scan/post__rest__v1.0__aggpay__pre-pay/index.html
示例调用:
yeepay_yop_api_detail("/rest/v1.0/aggpay/pre-pay")返回: API 接口的详细定义信息(markdown 格式)
5. yeepay_yop_java_sdk_user_guide()
获取易宝支付开放平台(YOP)的 yop-java-sdk 使用说明。
示例调用:
yeepay_yop_java_sdk_user_guide()返回: yop-java-sdk 使用说明(markdown 格式)
6. yeepay_yop_sdk_and_tools_guide()
获取易宝支付开放平台(YOP)提供的各种SDK和工具的使用说明,以及对接最佳实践等。
示例调用:
yeepay_yop_sdk_and_tools_guide()返回: SDK和工具的使用说明(markdown 格式)
7. yeepay_yop_link_detail(url)
获取易宝支付开放平台(YOP)的各个子页面或外部链接的详细内容。
参数:
url(字符串)- 易宝支付开放平台(YOP)的子页面的URL地址
示例调用:
yeepay_yop_link_detail("https://open.yeepay.com/docs-v3/platform/201.md")返回: 子页面的详细内容(markdown 格式)
8. yeepay_yop_gen_key_pair(algorithm, format, storage_type)
根据密钥算法生成非对称加密的密钥对(公钥和私钥),并保存到本地路径。
参数:
algorithm(字符串)- 密钥算法,可选值为 "RSA" 或 "SM2",默认为 "RSA"format(字符串)- 密钥格式,可选值为 "pkcs8"或"pkcs1",默认为 "pkcs8"storage_type(字符串)- 密钥存储类型,"file"或"string",默认为 "file"
示例调用:
yeepay_yop_gen_key_pair(algorithm="SM2", format="pkcs8", storage_type="file")返回: 生成的密钥对信息
9. yeepay_yop_download_cert(algorithm, serial_no, auth_code, private_key, public_key, pwd)
根据密钥算法、CFCA证书的序列号、授权码、非对称密钥对(公钥和私钥)、密码,下载该证书,并保存到本地路径。
参数:
algorithm(字符串)- 密钥算法,可选值为 "RSA" 或 "SM2",默认为 "RSA"serial_no(字符串)- cfca证书序列号auth_code(字符串)- cfca证书授权码private_key(字符串)- Base64 编码后的私钥字符串public_key(字符串)- Base64 编码后的公钥字符串pwd(字符串)- 密码,长度:12~16位
返回:
{
"message": "响应信息",
"pfxCert": "私钥证书路径(.pfx)",
"pubCert": "公钥证书路径(.cer)"
}10. yeepay_yop_parse_certificates(algorithm, pfxCert, pubCert, pwd)
根据证书文件解析出Base64编码后的公钥或私钥字符串。
参数:
algorithm(字符串)- 密钥算法,可选值为 "RSA" 或 "SM2",默认为 "RSA"pfxCert(字符串)- 私钥证书(.pfx)文件路径pubCert(字符串)- 公钥证书(.cer)文件路径pwd(字符串)- PFX证书的密码,默认为None
返回:
{
"message": "响应信息",
"privateKey": "Base64编码后的私钥字符串",
"publicKey": "Base64编码后的公钥字符串"
}❓ 常见问题
如何查找产品编码?
可以通过调用 yeepay_yop_product_overview() 获取产品概览,从中找到需要的产品编码。
如何获取完整的 API 列表?
先通过 yeepay_yop_product_overview() 获取产品编码,然后调用 yeepay_yop_product_detail_and_associated_apis(product_code) 获取特定产品的 API 列表。
接口返回错误怎么办?
系统已内置容错机制,如果特定接口请求失败,会尝试备用地址获取信息。
如何在不同的AI工具中使用?
本项目支持所有兼容MCP协议的AI工具,包括但不限于:
Claude Desktop
Cursor
其他支持MCP的AI开发工具
⚠️ 注意事项
所有接口返回的数据均为 markdown 格式,方便直接展示
确保网络连接正常,能够访问易宝支付开放平台
密钥和证书操作涉及敏感信息,请妥善保管
建议在测试环境中先验证功能后再在生产环境使用
🤝 贡献指南
我们欢迎所有形式的贡献!
如何贡献
Fork 本仓库
创建您的特性分支 (
git checkout -b feature/AmazingFeature)提交您的更改 (
git commit -m 'Add some AmazingFeature')推送到分支 (
git push origin feature/AmazingFeature)打开一个 Pull Request
开发指南
确保您的代码符合项目的编码规范
添加适当的测试用例
更新相关文档
确保所有测试通过
📄 许可证
本项目采用 Apache License 2.0 许可证。
🙏 致谢
感谢所有为这个项目做出贡献的开发者!
📞 支持
如果您在使用过程中遇到问题,可以通过以下方式获取帮助:
提交 Issue
查看 易宝支付开放平台文档
联系技术支持
🔗 相关链接
Made with ❤️ by YOP Team
Available Tools
10 toolsyeepay_yop_api_detailA
通过此工具,获取易宝支付开放平台(YOP)的API接口的详细定义,包含基本信息、请求参数、请求示例、 响应参数、响应示例、错误码、回调、示例代码等信息,内容中包含链接时可以调用工具yeepay_yop_link_detail进一步获取其详细内容
Args: api_uri: str - API的URI路径, 例如:/rest/v1.0/aggpay/pre-pay, https://open.yeepay.com/docs-v3/api/post_rest_v1.0_aggpay_pre-pay.md, https://open.yeepay.com/docs-v2/apis/user-scan/post__rest__v1.0__aggpay__pre-pay/index.html
Returns: str: 易宝支付开放平台(YOP)的API接口的详细定义,包含基本信息、请求参数、请求示例、 响应参数、响应示例、错误码、回调、示例代码等信息(markdown格式)
| Name | Required | Description | Default |
|---|---|---|---|
| api_uri | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It implicitly indicates a read-only operation by stating it retrieves information ('获取...详细定义'), and does not suggest any modifications or side effects. This adequately discloses the non-destructive nature.
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 well-structured with separate sections for Args and Returns, but it could be slightly more concise. The return part largely repeats the purpose. However, every sentence contributes value, and the formatting aids readability.
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 single-parameter tool with no annotations but an output schema, the description comprehensively covers usage: explains the parameter in detail, describes the return format, and links to a sibling tool for extended content. No missing information.
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 input schema has 0% coverage, but the description provides detailed semantics for the only parameter 'api_uri', including its purpose and multiple examples (e.g., '/rest/v1.0/aggpay/pre-pay'). This fully compensates for the schema's lack of description.
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 that the tool retrieves detailed API definitions from Yeepay Payment Platform (YOP), listing included information types and mentioning a sibling tool for further detail. This distinguishes it from siblings like yeepay_yop_download_cert and yeepay_yop_gen_key_pair.
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 explicitly states the tool's purpose and conditionally guides users to call yeepay_yop_link_detail when content contains links. While it lacks explicit when-not-to-use instructions, the context is clear for selecting this tool over siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
yeepay_yop_download_certA
根据密钥算法、CFCA证书的序列号、授权码、非对称密钥对(公钥和私钥)、密码,下载该证书,并保存到本地路径
Args: algorithm: 密钥算法,可选值为 "RSA" 或 "SM2",默认为 "RSA" serial_no: cfca证书序列号 auth_code: cfca证书授权码 private_key: Base64 编码后的私钥字符串 public_key: Base64 编码后的公钥字符串 pwd: 密码,长度:12~16位
Returns: Dict包含: - message: 响应信息 - pfxCert: 私钥证书路径(.pfx) - pubCert: 公钥证书路径(.cer)
| Name | Required | Description | Default |
|---|---|---|---|
| algorithm | No | RSA | |
| serial_no | No | ||
| auth_code | No | ||
| private_key | No | ||
| public_key | No | ||
| pwd | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Without annotations, the description discloses the download and save behavior, output structure, and constraints like password length. However, it does not mention side effects (e.g., overwriting) or error handling.
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 structured as a concise list of Args and Returns, with no unnecessary words. It is front-loaded with the main action and efficient.
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?
Given 6 parameters and no annotations, the description explains the output schema (Dict with message and file paths). It is mostly complete but lacks failure scenarios or edge-case handling.
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?
With 0% schema coverage, the description fully compensates by explaining each parameter's meaning (e.g., Base64 encoded key, password length 12-16), which the schema omits.
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 ('download this certificate') and the resource (CFCA certificate), distinguishing it from sibling tools like key pair generation or parsing.
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 versus alternatives (e.g., parse_certificates or gen_key_pair). No prerequisites or when-not-to-use context is included.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
yeepay_yop_gen_key_pairA
根据密钥算法生成非对称加密的密钥对(公钥和私钥),并保存到本地路径
参数: algorithm: 密钥算法,可选值为 "RSA" 或 "SM2",默认为 "RSA" key_format: 密钥格式,可选值为 "pkcs8"或"pkcs1",默认为 "pkcs8" storage_type: 密钥存储类型,"file"或"string",默认为 "file"
| Name | Required | Description | Default |
|---|---|---|---|
| algorithm | No | RSA | |
| key_format | No | pkcs8 | |
| storage_type | No | file |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It states the tool saves keys to a local path, but does not disclose potential side effects (e.g., overwriting existing files), permissions required, or whether generation occurs locally or involves external calls. Basic transparency but lacks depth.
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 concise: one sentence explaining the purpose followed by a succinct parameter list. It is front-loaded with the main action. However, the parameter descriptions are minimal (just enumerating options without explanations), which could be improved without adding much length.
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 tool saves to local path and has an output schema, but the description does not mention what the output represents (e.g., file paths or success status). For a simple generation tool, it is adequate but misses the chance to specify return semantics. Given the context signals (3 params, no nested objects), the description is somewhat complete but could be more explicit about outputs.
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 adds value by listing three parameters with possible values and defaults (algorithm: RSA/SM2, key_format: pkcs8/pkcs1, storage_type: file/string). However, it does not explain the semantics of each option (e.g., difference between pkcs8 and pkcs1), which would further aid the agent. Still, it provides meaning beyond the bare schema.
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 it generates an asymmetric encryption key pair (public and private) based on an algorithm and saves to a local path. This specific verb+resource distinguishes it from sibling tools like yeepay_yop_download_cert or yeepay_yop_parse_certificates.
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 provides no explicit guidance on when to use this tool vs alternatives. While the purpose is clear, there is no mention of prerequisites, scenarios, or exclusions. Given it is a key generation tool, usage is implied but not explicitly guided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
yeepay_yop_java_sdk_user_guideA
通过此工具,获取易宝支付开放平台(YOP)的yop-java-sdk的使用说明,内容中包含链接时可以调用工具yeepay_yop_link_detail进一步获取其详细内容
Returns: str: 易宝支付开放平台(YOP)的yop-java-sdk的使用说明(markdown格式)
| 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?
描述说明了返回格式为markdown,且隐含了输出可能包含链接。无注解配置,但工具行为简单,无副作用或隐藏行为。
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?
两句话,第一句直接点明用途,第二句补充与兄弟工具的关系,无冗余信息,结构高效。
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?
对于无参数、有输出schema的简单工具,描述提供了足够的信息(用途、输出格式、关联工具)。但未详细说明输出内容结构,略微不足。
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覆盖100%,描述无需添加参数信息。描述本身简洁有效,未遗漏任何必要说明。
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?
描述明确表明工具用于获取易宝支付yop-java-sdk的使用说明,动词'获取'和资源'使用说明'清晰。同时提及内容中包含链接时可调用兄弟工具yeepay_yop_link_detail,有效区分了兄弟工具。
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?
描述给出了具体使用场景:当需要获取链接详细内容时使用yeepay_yop_link_detail,提供了清晰的上下文。但未明确说不应使用本工具的情形或替代方案,由于工具简单,该信息足够。
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
yeepay_yop_link_detailB
通过此工具,获取易宝支付开放平台(YOP)的各个子页面或者外部链接的详细内容,内容中包含链接时可以调用工具yeepay_yop_link_detail进一步获取其详细内容
Args: url: str - 易宝支付开放平台(YOP)的子页面的URL地址
Returns: str: 易宝支付开放平台(YOP)的各个子页面的详细内容
| 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?
No annotations are provided, so the description must fully disclose behavior. It states the tool returns detailed content but does not mention side effects, authentication needs, rate limits, or error conditions. The read-only nature is assumed but not stated.
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 concise, with the purpose stated in the first sentence and Args/Returns clearly separated. It uses minimal words, though the Chinese phrasing is somewhat repetitive on the platform name.
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 tool with one parameter and an output schema, the description covers the essential functionality. It could mention the output format (e.g., plain text or HTML) but is generally complete given the tool's simplicity.
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 schema has 0% description coverage, but the description provides a brief explanation for the 'url' parameter ('易宝支付开放平台(YOP)的子页面的URL地址'), adding meaning beyond the type. However, it does not specify URL format or constraints.
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 states the tool retrieves detailed content of subpages or external links of YeePay Open Platform, which is clear. However, it does not explicitly differentiate from sibling tools like 'yeepay_yop_api_detail', so a distinction is implied but not explicit.
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 mentions recursive usage when content contains links, but no guidance on when not to use this tool or alternatives. For example, it does not clarify when to use yeepay_yop_link_detail vs yeepay_yop_product_detail_and_associated_apis.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
yeepay_yop_overviewA
通过此工具,可以了解易宝支付开放平台(YOP)的平台规范,接入流程,网站地图,内容中包含链接时可以调用工具yeepay_yop_link_detail进一步获取其详细内容
Returns: str: 易宝支付开放平台(YOP)的概览信息(markdown格式)
| 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?
No annotations provided, so description carries full burden. It discloses that the tool returns overview information in markdown format, which is transparent. No side effects are mentioned, but as a read-only overview, this is acceptable.
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 a single sentence plus a return line, no wasted words. It immediately states the tool's function and how to navigate further.
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?
Given no parameters and an output schema (though not detailed), the description is fairly complete. It explains the return format and provides navigation hints, making it sufficient for a simple overview tool.
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 baseline is 4. The description adds meaning by explaining what content will be returned, making the tool's purpose clear beyond the schema.
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 it provides an overview of the YOP platform including specifications, access process, and site map. It differentiates from sibling 'product_overview' by being platform-wide, but could be more explicit about scope.
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 hints at usage by mentioning that if content contains links, one should use 'yeepay_yop_link_detail'. However, it does not explicitly state when to use this tool over siblings or exclude cases.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
yeepay_yop_parse_certificatesA
根据证书文件解析出Base64编码后的公钥或私钥字符串
Args: algorithm (str): 密钥算法,可选值为 "RSA" 或 "SM2",默认为 "RSA" pfx_cert (str): 私钥证书(.pfx)文件路径 pub_cert (str): 公钥证书(.cer)文件路径 pwd (str, optional): PFX证书的密码,默认为None
Returns: dict: 包含解析结果的字典,格式如下: { 'message': 响应信息, 'privateKey': Base64编码后的私钥字符串, 'publicKey': Base64编码后的公钥字符串 }
| Name | Required | Description | Default |
|---|---|---|---|
| algorithm | No | RSA | |
| pfx_cert | No | ||
| pub_cert | No | ||
| pwd | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Given no annotations, the description carries the behavioral burden. It explains the core operation and return format but omits details about error handling, side effects, or authorization requirements.
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 well-structured with Args and Returns sections, providing necessary details without unnecessary verbosity. It is concise but could be slightly tighter.
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 covers the main functionality and return format adequately. Given the output schema exists, it does not need to repeat the return structure. It is mostly complete but lacks guidance on edge cases or file requirements.
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?
With 0% schema coverage, the description adds significant value by explaining each parameter's purpose (algorithm, file paths, password) and the return dictionary structure, going beyond the bare schema.
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 explicitly states that the tool parses certificate files to extract Base64-encoded public or private key strings, clearly differentiating from sibling tools like key generation or download.
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 usage guidelines are provided; the description does not indicate when to use this tool versus alternatives, nor does it specify prerequisites or contexts.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
yeepay_yop_product_detail_and_associated_apisA
通过此工具,获取易宝支付开放平台(YOP)指定产品的产品介绍,使用说明、相关的API接口列表,内容中包含链接时可以调用工具yeepay_yop_link_detail进一步获取其详细内容
Args: product_code: str - 产品编码(产品的唯一标识)
Returns: str: 易宝支付开放平台(YOP)指定产品的产品介绍,使用说明、相关的API接口列表(markdown格式)
| Name | Required | Description | Default |
|---|---|---|---|
| product_code | 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 provided, the description carries the full burden. It discloses that the tool returns markdown-formatted content including product details, usage instructions, and API lists. It also highlights the presence of links for further exploration. No destructive behavior is implied.
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 concise, front-loading the main purpose and then providing structured Args and Returns sections. It is efficient, though could be slightly more streamlined.
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?
Given the single parameter and no annotations, the description adequately covers what the tool does and returns (markdown format). It also references a sibling for further detail, which is helpful context. Without output schema details, the return description suffices.
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 description's Args section explains that product_code is the unique product identifier, adding meaning beyond the input schema which only provides a title and type. With 0% schema description coverage, this clarification is valuable.
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 tool retrieves product introductions, usage instructions, and associated API lists for a specified YOP product. It also mentions that links within can be further explored via a sibling tool (yeepay_yop_link_detail), effectively distinguishing its role.
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 explicitly advises using a sibling tool (yeepay_yop_link_detail) for deeper detail on links within the content. This guides the agent on when to use alternatives. However, it does not specify when not to use this tool compared to other product-related siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
yeepay_yop_product_overviewA
通过此工具,获取易宝支付开放平台(YOP)的产品能力概览,内容中包含链接时可以调用工具yeepay_yop_link_detail进一步获取其详细内容
Returns: str: 易宝支付开放平台(YOP)的产品能力概览(markdown格式)
| 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?
No annotations are provided, and the description does not disclose any behavioral traits such as authentication requirements, rate limits, or side effects. It only implies a read operation by saying 'get', but fails to provide explicit safety or dependency info.
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 a single sentence that front-loads the main purpose and immediately follows with an important usage note about the sibling tool. No words are wasted, and it is well-structured.
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 parameterless tool with output described, the description covers the main use and linking behavior. However, it does not differentiate from the very similarly named sibling tool 'yeepay_yop_overview', which could cause confusion. Hence a slight deduction.
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?
There are no parameters, and schema coverage is 100%. The description adds some value by mentioning the output format (markdown) and linking behavior, but these are not parameter semantics. Following the baseline rule, a score of 3 is appropriate.
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 tool retrieves an overview of YOP product capabilities, using a specific verb ('get') and resource. It also distinguishes itself by noting that when links appear in the output, the sibling tool yeepay_yop_link_detail should be used, which clarifies its scope.
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 provides explicit guidance on when to use this tool (to get an overview) and when to use an alternative (yeepay_yop_link_detail for details of links). However, it does not differentiate from the similarly named sibling tool 'yeepay_yop_overview', so it slightly lacks completeness in terms of when not to use this tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
yeepay_yop_sdk_and_tools_guideA
通过此工具,获取易宝支付开放平台(YOP)提供的各种SDK和工具的使用说明,内容中包含链接时可以调用工具yeepay_yop_link_detail进一步获取其详细内容
Returns: str: 易宝支付开放平台(YOP)提供的各种SDK和工具的使用说明,以及对接最佳实践等(markdown格式)
| 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?
No annotations provided, so the description carries the burden. It discloses that the tool retrieves instructions and may include links, but no further behavioral details (e.g., no destructive actions). This is adequate for a simple retrieval tool.
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 two sentences, front-loading the purpose and a usage hint. Every sentence is necessary and concise.
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?
Given zero parameters and a simple return value (markdown string), the description is sufficient. It also mentions a related tool, enhancing completeness for agents.
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?
There are zero parameters, so baseline is 4. The description does not need to add parameter meaning as there are none.
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 that the tool provides usage instructions for SDKs and tools from Yeepay Open Platform. It distinguishes itself by mentioning when to use a sibling tool for links.
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 gives explicit guidance on using yeepay_yop_link_detail for detailed content, implying this tool is for initial instructions. However, it does not specify when to prefer this over other sibling tools like yeepay_yop_api_detail.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
10 tool updates
- First observed
yeepay_yop_api_detail - First observed
yeepay_yop_download_cert - First observed
yeepay_yop_gen_key_pair - First observed
yeepay_yop_java_sdk_user_guide - First observed
yeepay_yop_link_detail - First observed
yeepay_yop_overview - First observed
yeepay_yop_parse_certificates - First observed
yeepay_yop_product_detail_and_associated_apis - First observed
yeepay_yop_product_overview - First observed
yeepay_yop_sdk_and_tools_guide
TDQS
Scored across 10 tools
Several tools retrieve information from the Yeepay platform (overview, product overview, product detail, API detail, link detail), leading to potential confusion. However, descriptions clarify their specific purposes (e.g., overview vs. product overview).
All tools follow a consistent pattern: 'yeepay_yop_' prefix followed by descriptive snake_case names (e.g., api_detail, gen_key_pair), making it predictable.
10 tools is well-scoped for a documentation and certificate management server, covering essential functions without being excessive or thin.
The tool surface covers platform overview, product details, API specs, SDK guide, and certificate lifecycle (generation, download, parsing). Minor gaps like missing structured product listing or API search, but agents can work around these.
Maintenance
Related MCP Connectors
A comprehensive Model Context Protocol (MCP) server that enables AI assistants to interact with yo…
The Mercado Pago MCP Server implements the Model Context Protocol to provide AI agents and LLMs with access to Mercado Pago's APIs and tools within compatible development environments. It acts as an intermediary that translates Mercado Pago resources into executable functions (tools) that AI applications can invoke to perform actions and automate flows. The server simplifies integration, enables using documentation to implement or improve code, and optimizes operations through natural language interactions without manual implementations.
Model Context Protocol server for the Apideck Unified API. Connect any MCP-compatible agent framework to 100+ accounting systems, HRIS platforms, file storage providers, and more through one integration. More information https://www.apideck.com/mcp-server
AI-native mock API server with MCP. Create REST/SOAP mocks from Claude, Cursor, or Windsurf.
Related MCP Servers
- AlicenseDqualityDmaintenanceA foundation for building custom local Model Context Protocol (MCP) servers that provide tools accessible to AI assistants like Cursor or Claude Desktop.137MIT
- AlicenseNot gradedqualityFmaintenanceAn MCP server for the YApi platform that allows AI assistants to search, create, and manage API documentation directly within tools like Cursor. It supports multi-project management and seamless integration into AI-driven programming workflows for interface maintenance.1,679 npm118MIT
- AlicenseNot gradedqualityDmaintenanceAn MCP server that enables fetching YApi interface details via a tool, allowing AI assistants to generate API code based on YApi documentation.23 npmISC
- AlicenseAqualityDmaintenance这是一个面向中文圈的MCP服务器,将中国互联网常用能力(如地图、快递、RSS、B站等)封装为标准MCP工具,方便AI Agent安全调用。132MIT