ApiPost MCP
ApiPost MCP is an API management tool that integrates with ApiPost's OpenAPI to manage documentation, directories, and workspaces through the MCP protocol.
Core Capabilities:
Connection & Workspace
Test connectivity and verify configuration with
apipost_test_connectionView, list, and switch between teams/projects by ID or name using
apipost_workspace
API Documentation Structure
Create hierarchical folder structures with parent-child relationships via
apipost_create_folderOrganize APIs in nested directories for better structure
API Interface Operations
Smart Create (
apipost_smart_create): Generate complete API documentation with HTTP methods, request parameters (headers, query, body, cookies), response examples with field definitions, authentication configurations, and automatic URL prefix handlingUpdate (
apipost_update): Incremental field-level updates—keep unchanged fields, delete by supplying empty values, replace with new valuesView (
apipost_detail): Retrieve complete API configuration and specificationsDelete (
apipost_delete): Batch deletion of single or multiple API interfaces
Advanced Search & Navigation (apipost_list)
Multi-dimensional search by name, URL, method, ID, or description
Hierarchical filtering by type (API, folder, or all)
Recursive search within subdirectories with depth control
Display options: tree view, list view, or grouped by folder with path navigation
Flexible result limits (default 50, max 200, or show all)
Security & Permissions
Three security modes:
readonly(view-only),limited(read/write, no deletion),full(complete access)Token-based authentication for secure API access
Special Features
URL prefix management: Automatically prepend defined prefixes to API paths
Field-level control with support for nested objects and arrays
Optional inline comment generation in response examples
Supports project installation via Git clone commands.
Requires Node.js 16+ as runtime environment for the MCP server.
Used for dependency management and build processes with commands like 'npm install' and 'npm run build'.
Implemented using TypeScript for type safety and improved development experience.
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., "@ApiPost MCPlist all APIs in the user management folder"
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.
ApiPost MCP
基于 MCP 协议和 ApiPost 官方 OpenAPI 实现的 API 管理工具。
功能
连接测试 - 一键验证MCP服务器状态和配置
工作空间管理 - 查看、切换团队和项目工作空间
目录管理 - 创建API文档目录,支持层级结构
API接口管理 - 创建、查看、修改、删除接口文档
增量更新 - 支持字段级别的精确更新和删除
层级搜索 - 强化的目录层级搜索和父子关系定位
递归浏览 - 递归搜索子目录,支持深度限制
多维筛选 - 多维度搜索和批量操作
结构化显示 - 树形结构和分组显示
路径导航 - 完整路径显示,快速定位
权限管理 - 多种安全模式,灵活的操作权限控制
Related MCP server: ApiFox MCP Server
安装
环境要求
在开始安装之前,请确保您的系统已安装以下环境:
环境 | 版本要求 | 说明 |
Node.js | >= 18.0.0 | JavaScript 运行环境(MCP SDK 官方最低要求) |
npm | >= 8.0.0 | Node.js 包管理器(通常随 Node.js 一起安装) |
环境安装指南
Node.js 安装:
访问 Node.js 官网 下载 LTS 版本
或使用包管理器:
# macOS (使用 Homebrew) sudo brew install node # Ubuntu/Debian sudo apt update && sudo apt install nodejs npm # CentOS/RHEL sudo yum install nodejs npm
验证安装:
node --version # 应显示 v18.0.0 或更高版本
npm --version # 应显示 8.0.0 或更高版本开始安装
git clone https://github.com/jlcodes99/apipost-mcp.git
cd apipost-mcp
npm install && npm run build配置
在 MCP 配置文件中添加:
{
"mcpServers": {
"apipost": {
"command": "node",
"args": ["/absolute/path/to/apipost-mcp/dist/index.js"],
"env": {
"APIPOST_TOKEN": "your_access_token_here",
"APIPOST_HOST": "https://open.apipost.net",
"APIPOST_SECURITY_MODE": "limited",
"APIPOST_DEFAULT_TEAM_NAME": "你的团队名称",
"APIPOST_DEFAULT_PROJECT_NAME": "你的项目名称",
"APIPOST_URL_PREFIX": "接口前缀可定义常量比如{{host}}"
}
}
}
}
环境变量
变量名 | 是否必需 | 说明 |
| 是 | API访问令牌 |
| 否 | 安全模式: |
| 否 | 默认团队名称 |
| 否 | 默认项目名称 |
| 否 | 接口URL前缀,自动拼接到所有新建/修改的接口路径,如 |
安全模式说明
模式 | 权限 | 说明 |
| 只读 | 仅允许查看接口列表和详情,禁止创建、修改、删除 |
| 读写 | 允许查看、创建、修改接口,禁止删除操作 |
| 完全访问 | 允许所有操作,包括查看、创建、修改、删除 |
可用工具
工具 | 功能 | 主要参数 |
| 连接测试 |
|
| 工作空间管理 |
|
| 创建目录 |
|
| 创建接口 |
|
| 强化列表搜索 |
|
| 查看详情 |
|
| 修改接口 |
|
| 删除接口 |
|
apipost_test_connection 说明
快速诊断工具,适合首次使用或故障排查:
✅ 验证MCP服务器连接状态
🔧 检查环境变量配置
🏢 显示当前工作空间信息
🛠️ 检查操作权限和安全模式
📊 提供系统环境详情
apipost_workspace 说明
统一的工作空间管理工具,支持以下操作:
Action | 功能 | 主要参数 | 说明 |
| 查看当前工作空间 |
| 显示当前团队、项目信息,可选显示所有可用选项 |
| 列出团队 |
| 显示所有可用团队,标识当前团队 |
| 列出项目 |
| 显示指定团队的项目列表 |
| 切换工作空间 |
| 切换到指定的团队和项目 |
使用示例:
# 查看当前工作空间
apipost_workspace action: "current"
# 列出所有团队
apipost_workspace action: "list_teams" show_details: true
# 列出项目
apipost_workspace action: "list_projects" team_id: "your_team_id"
# 切换工作空间(支持按名称或ID)
apipost_workspace action: "switch" team_name: "团队名" project_name: "项目名"apipost_create_folder 说明
API文档目录创建工具,支持在指定父目录下创建新的文件夹:
参数 | 类型 | 必需 | 说明 |
| string | 是 | 目录名称 |
| string | 否 | 父目录ID,使用"0"表示根目录,默认为"0" |
| string | 否 | 目录描述(可选) |
使用示例:
# 在根目录创建目录
apipost_create_folder name: "用户管理" description: "用户相关接口"
# 在指定目录下创建子目录
apipost_create_folder name: "认证接口" parent_id: "folder_123" description: "用户认证相关接口"apipost_list 参数说明
参数 | 类型 | 说明 |
| string | 搜索关键词(接口名称、URL、方法、ID、描述) |
| string | 父目录ID,精确查找子项目。"0"为根目录 |
| string | 类型筛选: |
| boolean | 显示树形结构,默认false为列表模式 |
| boolean | 显示完整路径,默认false |
| boolean | 递归搜索子目录,默认false |
| number | 深度限制(配合recursive),默认无限制 |
| boolean | 按目录分组显示,默认false |
| number | 显示数量限制(默认50,最大200) |
| boolean | 显示全部(忽略limit限制) |
apipost_smart_create 说明(字段列表驱动)
规则(强制):
responses只传fields,不要传data;所有字段(含父级)必须带desc。headers/query/body/cookies 用字段列表字符串,嵌套用
.,数组用[](如meta.flags.debug、items[].id),example 填真实值,不要放 JSON 字符串。父级需显式声明并写
desc,示例:{"key":"data","type":"object","desc":"返回体"},{"key":"data.user","type":"object","desc":"用户"},{"key":"data.user.id","type":"integer","example":1,"desc":"用户ID"}。可选
APIPOST_INLINE_COMMENTS=true时,raw 会按desc生成行内注释(mock 始终为纯 JSON)。可选
APIPOST_URL_PREFIX={{ajllxa}}时,创建或更新接口时会将前缀自动拼接到 URL(避免手动重复填写路由常量)。
必填:method、url、name。其他字段(均为字符串化 JSON 数组/对象):
headers/query/body/cookies:
[{"key":"X-Request-ID","type":"string","required":true,"example":"req-1","desc":"说明"}]responses:
[{"name":"成功","status":200,"fields":[{"key":"code","type":"integer","example":0,"desc":"状态码"},{"key":"data.items[].id","type":"string","example":"1","desc":"商品ID"}]}]auth:
{"type":"bearer","bearer":{"key":"your_token"}}
字段类型:string/integer/number/boolean/object/array/null
示例(嵌套):
"body": "[{\"key\":\"user.id\",\"type\":\"integer\",\"required\":true,\"example\":9001,\"desc\":\"用户ID\"},{\"key\":\"user.profile.tags[]\",\"type\":\"string\",\"example\":\"vip\",\"desc\":\"标签\"}]",
"responses": "[{\"name\":\"成功\",\"status\":200,\"fields\":[{\"key\":\"code\",\"type\":\"integer\",\"example\":0,\"desc\":\"状态码\"},{\"key\":\"data.user.profile.tags[]\",\"type\":\"string\",\"example\":\"vip\",\"desc\":\"标签\"}]}]"获取 Token
用户api_token。获取方式:Apipost客户端>工作台>项目设置>对外能力>open API
📝 更新日志
查看 CHANGELOG.md 了解版本更新信息。
💡 提示:这是一个专注于API接口管理的MCP工具,简化了接口创建和管理流程,提高团队协作效率。
联系方式
📧 邮箱: jlcodes@163.com
🐛 问题反馈: GitHub Issues
🌟 项目主页: GitHub Repository
相关链接
⭐ 如果这个项目对你有帮助,请给我们一个星标!
Available Tools
8 toolsapipost_create_folderC
创建API文档目录,支持在指定父目录下创建新的文件夹
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | 目录名称 | |
| parent_id | No | 父目录ID,使用"0"表示根目录,默认为"0" | |
| description | No | 目录描述(可选) |
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 creates folders, implying a write/mutation operation, but fails to disclose critical behavioral traits: required permissions, whether creation is idempotent, error handling (e.g., duplicate names), rate limits, or what happens on success/failure. The description is basic and leaves the agent guessing about operational risks.
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, efficient sentence in Chinese that directly states the tool's purpose and key capability (parent directory support). It is front-loaded with the main action and wastes no words, making it easy for an AI agent to parse quickly.
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 tool's complexity (a write operation with 3 parameters) and lack of annotations and output schema, the description is incomplete. It doesn't cover behavioral aspects like permissions or errors, output format, or usage context. For a mutation tool with no structured safety hints, this leaves significant gaps for an AI agent to operate safely and effectively.
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 100%, with clear parameter descriptions in the schema itself. The description adds no additional semantic meaning beyond what the schema provides (e.g., no examples, format details, or constraints). With high schema coverage, the baseline is 3, as the description doesn't compensate but also doesn't detract.
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 ('创建API文档目录' - create API documentation directory) and resource (folder/directory), with the specific capability to create under a parent directory. It distinguishes from siblings like 'apipost_delete' (deletion) and 'apipost_list' (listing), though not explicitly named. It loses a point for not explicitly contrasting with 'apipost_smart_create' which might have overlapping functionality.
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 minimal guidance: it mentions creating folders under a parent directory, but offers no explicit when-to-use advice, no prerequisites (e.g., authentication needs), no exclusions (e.g., when not to use it), and no alternatives (e.g., vs. 'apipost_smart_create'). Usage is implied by the action, but lacks actionable context for an AI agent.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
apipost_deleteA
批量删除API接口文档,支持单个或多个接口删除。删除前先用apipost_list查看接口列表获取ID
| Name | Required | Description | Default |
|---|---|---|---|
| api_ids | Yes | API接口ID数组(可从列表中获取target_id)- 支持单个["id1"]或多个["id1","id2","id3"] |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It discloses that the tool performs deletion ('删除'), which implies a destructive mutation, and mentions it supports batch operations ('批量删除', '支持单个或多个接口删除'). However, it lacks details on permissions required, whether deletions are reversible, error handling, or rate limits. For a destructive tool with zero annotation coverage, this is a moderate gap, but the description at least clarifies the batch 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 highly concise and front-loaded: the first sentence states the core action and scope ('批量删除API接口文档,支持单个或多个接口删除'), and the second sentence provides essential usage guidance. Every sentence earns its place with no wasted words, making it efficient and easy to parse.
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 tool's complexity (destructive mutation with batch support), no annotations, no output schema, and 100% schema coverage, the description is moderately complete. It covers the purpose, usage prerequisites, and parameter basics, but lacks behavioral details like side effects, permissions, or return values. For a deletion tool, this leaves gaps in understanding the full impact, though the core functionality is clear.
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 100%, with the parameter 'api_ids' fully documented in the schema as an array of strings for API interface IDs. The description adds minimal value beyond the schema: it reiterates that IDs can be obtained from apipost_list and supports single or multiple IDs, which is already covered in the schema description. Since schema coverage is high, the baseline is 3, and the description doesn't significantly enhance parameter understanding.
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's purpose: '批量删除API接口文档' (batch delete API interface documents) with the specific action '删除' (delete) on the resource 'API接口文档' (API interface documents). It distinguishes from siblings like apipost_list (view) and apipost_update (modify), though it doesn't explicitly name alternatives. The purpose is specific but could be slightly more differentiated from other destructive operations.
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 clear context for when to use this tool: '删除前先用apipost_list查看接口列表获取ID' (before deleting, first use apipost_list to view the interface list and get IDs). This gives a prerequisite step and implicitly distinguishes from apipost_list (for viewing) and apipost_detail (for details). However, it doesn't explicitly state when NOT to use it or name all alternatives (e.g., vs. apipost_update for modifications).
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
apipost_detailC
查看API接口的详细配置信息,包括完整的请求参数、响应格式、认证设置等。
| Name | Required | Description | Default |
|---|---|---|---|
| target_id | Yes | 要查看的接口ID |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the tool views detailed configuration information, implying a read-only operation, but doesn't clarify if it requires authentication, has rate limits, returns structured data, or handles errors. The description lacks details on behavioral traits beyond the basic action, leaving gaps for an AI agent to understand how to invoke it correctly.
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, efficient sentence that directly states the tool's purpose and scope. It's front-loaded with the main action and includes specific details (request parameters, response format, authentication settings) without unnecessary elaboration. However, it could be slightly more structured by separating usage context, but it's appropriately sized with zero waste.
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 tool's complexity (a read operation with 1 parameter), no annotations, and no output schema, the description is minimally adequate. It covers what the tool does but lacks behavioral context (e.g., authentication needs, error handling) and output details. It's complete enough for basic understanding but has clear gaps that could hinder an AI agent's ability to use it effectively without additional inference.
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 1 parameter with 100% description coverage ('要查看的接口ID' - the interface ID to view). The description adds no additional meaning beyond the schema, as it doesn't explain parameter usage, format, or examples. With high schema coverage, the baseline is 3, and the description doesn't compensate or add value, so it scores 3.
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's purpose: '查看API接口的详细配置信息' (view detailed configuration information of an API interface). It specifies the resource (API interface) and the action (view detailed configuration), which includes request parameters, response format, and authentication settings. However, it doesn't explicitly differentiate from sibling tools like 'apipost_list' (which might list interfaces without details) or 'apipost_test_connection' (which might test connectivity rather than show configuration).
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 guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing an interface ID), exclusions (e.g., not for creating or updating interfaces), or comparisons to siblings like 'apipost_list' (for listing) or 'apipost_update' (for modifying). Usage is implied only by the action 'view,' but no explicit context is given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
apipost_listC
查看项目API列表,支持强化的目录层级搜索和父子关系定位
| Name | Required | Description | Default |
|---|---|---|---|
| search | No | 搜索关键词(接口名称、URL、方法、ID、描述) | |
| parent_id | No | 父目录ID,精确查找某个目录下的子项目。使用"0"查看根目录,使用具体ID查看子目录 | |
| target_type | No | 项目类型筛选:api(仅接口)、folder(仅目录)、all(全部),默认all | |
| show_structure | No | 是否显示层级结构(树形展示),默认false为列表模式 | |
| show_path | No | 是否显示完整路径(从根目录到当前项目的完整路径),默认false | |
| recursive | No | 是否递归搜索子目录(搜索指定目录及其所有子目录),默认false仅搜索当前层级 | |
| depth | No | 层级深度限制(配合recursive使用,限制搜索深度),默认无限制 | |
| group_by_folder | No | 是否按目录分组显示结果,默认false | |
| limit | No | 显示数量限制(默认50,最大200) | |
| show_all | No | 显示全部项目(忽略limit限制) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions 'enhanced directory hierarchy search and parent-child relationship positioning,' which hints at search and filtering capabilities, but fails to describe critical behaviors such as pagination (implied by 'limit' parameter), read-only nature (likely, but not stated), error handling, or response format. For a tool with 10 parameters and no annotations, this leaves significant gaps in understanding how the tool behaves in practice.
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, efficient sentence that front-loads the core purpose ('view project API list') and adds key features ('enhanced directory hierarchy search and parent-child relationship positioning'). There's no wasted verbiage, and it directly addresses the tool's functionality. However, it could be slightly more structured by explicitly separating purpose from features, but it remains appropriately concise for the tool's complexity.
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 tool's complexity (10 parameters, no annotations, no output schema), the description is incomplete. It lacks information on behavioral traits (e.g., read-only vs. mutative, rate limits), response format, error conditions, and usage context relative to siblings. While the schema covers parameters well, the description fails to provide the broader context needed for an agent to use the tool effectively, especially without annotations or output schema to fill in gaps.
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 100% description coverage, with each parameter well-documented in the schema itself (e.g., 'search' for keywords, 'parent_id' for directory filtering). The description adds no additional parameter semantics beyond what the schema provides—it doesn't explain interactions between parameters like 'recursive' and 'depth' or clarify default behaviors. Given the high schema coverage, the baseline score of 3 is appropriate, as the description doesn't compensate but also doesn't detract.
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's purpose as '查看项目API列表' (view project API list) with additional capabilities for '强化的目录层级搜索和父子关系定位' (enhanced directory hierarchy search and parent-child relationship positioning). It specifies the verb ('view') and resource ('project API list'), making the purpose understandable. However, it doesn't explicitly differentiate from sibling tools like 'apipost_detail' or 'apipost_workspace', which might offer overlapping or related functionality.
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 guidance on when to use this tool versus alternatives. It mentions enhanced search and hierarchy features but doesn't specify scenarios where this is preferred over other tools like 'apipost_detail' for detailed views or 'apipost_workspace' for workspace-level operations. Without explicit when-to-use or when-not-to-use instructions, the agent lacks clear direction for tool selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
apipost_smart_createB
API接口文档生成器(字段列表驱动)。规则:responses 只传 fields,不传 data;headers/query/body/cookies 统一用字段列表,嵌套用 .,数组用 [];example 填真实值(不要 JSON 字符串);所有字段含父级都必须写 desc,父级需显式声明。例如:{"key":"data","desc":"返回体","type":"object"},{"key":"data.user","desc":"用户","type":"object"},{"key":"data.user.id","desc":"用户ID","type":"integer","example":1}
| Name | Required | Description | Default |
|---|---|---|---|
| method | Yes | HTTP方法 | |
| url | Yes | 接口URL路径 | |
| name | Yes | 接口名称 | |
| parent_id | No | 父目录ID,使用"0"表示根目录,默认为"0" | |
| description | No | 接口详细描述(可选) | |
| headers | No | Headers字段列表字符串,格式:[{"key":"X-Request-ID","type":"string","required":false,"example":"req-1","desc":"说明"}] | |
| query | No | Query字段列表字符串,格式同上。嵌套用 .,数组用 [](如 meta.flags.debug 或 items[].id)。 | |
| body | No | Body字段列表字符串,仅用字段列表生成 raw/参数描述,example 用真实值,不要放 JSON 字符串。 | |
| cookies | No | Cookies字段列表字符串,格式同上。 | |
| auth | No | 认证配置JSON字符串(可选)。格式:{"type":"bearer","bearer":{"key":"your_token"}} | |
| responses | No | 响应字段列表字符串(必填 fields),格式:[{"name":"成功","status":200,"fields":[{"key":"code","type":"integer","example":0,"desc":"状态码"},{"key":"data.items[].id","type":"string","example":"1"}]}] |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It describes the tool's input formatting rules and constraints (e.g., 'example 填真实值' - fill example with real values), which adds useful context beyond the schema. However, it doesn't disclose critical behavioral traits such as whether this creates new documentation (implied by '生成器' - generator), what permissions are required, whether it's idempotent, what happens on errors, or what the output looks like (no output schema). For a creation tool with 11 parameters, this leaves significant gaps.
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 appropriately sized but not optimally structured. It front-loads the purpose ('API接口文档生成器') but then dives into detailed formatting rules without clear separation. The example at the end is helpful but makes the text somewhat dense. While every sentence contributes information, the flow could be improved for better readability, such as by grouping rules separately from examples.
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 complexity (11 parameters, no annotations, no output schema), the description is incomplete. It covers formatting rules and provides an example, but lacks crucial context: what the tool actually produces (API documentation object?), how to handle errors, authentication requirements, or rate limits. For a tool that likely creates resources in a system, this omission is significant, especially without annotations to fill these gaps.
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 description coverage is 100%, so the schema already documents all 11 parameters thoroughly with descriptions and examples. The description adds some semantic context by explaining the overall field-list-driven approach and providing formatting examples (e.g., nested用 .,数组用 [] - nested use ., arrays use []). However, it doesn't add significant meaning beyond what's already in the parameter descriptions, maintaining the baseline score for high schema coverage.
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's purpose as an 'API接口文档生成器(字段列表驱动)' (API documentation generator driven by field lists), which is a specific verb+resource combination. It distinguishes from siblings like apipost_create_folder (creates folders) or apipost_test_connection (tests connections) by focusing on API documentation generation. However, it doesn't explicitly contrast with apipost_update (which might update documentation) or apipost_detail (which might retrieve documentation details).
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 implied usage guidelines through rules like 'responses 只传 fields,不传 data' (responses only pass fields, not data) and formatting conventions for headers/query/body/cookies. It suggests when to use this specific format-driven approach. However, it lacks explicit guidance on when to choose this tool over alternatives like apipost_update for modifications or apipost_detail for retrieval, and doesn't mention prerequisites or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
apipost_test_connectionB
测试ApiPost MCP连接状态和配置信息,验证服务可用性
| Name | Required | Description | Default |
|---|---|---|---|
| random_string | Yes | Dummy parameter for no-parameter tools |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden of behavioral disclosure. While it states the tool tests connection status and verifies service availability, it doesn't describe what happens during execution (e.g., whether it makes network calls, what authentication is required, what happens on failure, or what the response looks like). For a tool with zero annotation coverage, this is a significant gap in behavioral context.
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 extremely concise - a single sentence in Chinese that efficiently communicates the core purpose. It's front-loaded with the essential information (testing connection status and configuration, verifying availability) with zero wasted words. Every part of the 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?
Given this is a simple connection testing tool with 1 dummy parameter and no output schema, the description is minimally complete. It tells what the tool does but lacks details about what '验证服务可用性' (verify service availability) actually means in practice - what constitutes success/failure, what information is returned, or how it differs from other status-checking tools. The absence of annotations and output schema means more behavioral context would be helpful.
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 100% description coverage, with the single parameter 'random_string' documented as 'Dummy parameter for no-parameter tools'. The description doesn't add any parameter information beyond what the schema provides, but since this is essentially a no-parameter tool (the parameter is a dummy), the baseline for 0 meaningful parameters would be 4. The description appropriately doesn't waste space on parameter details.
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's purpose: '测试ApiPost MCP连接状态和配置信息,验证服务可用性' (Test ApiPost MCP connection status and configuration information, verify service availability). It specifies the verb ('测试' - test/verify) and resource ('连接状态和配置信息' - connection status and configuration information). However, it doesn't explicitly differentiate from sibling tools like 'apipost_list' or 'apipost_detail' which might also provide status information.
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 minimal usage guidance. It implies this tool should be used to verify service availability, but doesn't specify when to use it versus alternatives like 'apipost_list' (which might list resources) or 'apipost_detail' (which might provide detailed information). No explicit when/when-not guidance or prerequisites are mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
apipost_updateC
修改API接口文档。规则同创建:responses 只用 fields(必填),不要传 data;headers/query/body/cookies 统一用字段列表,嵌套用 .,数组用 [],example 填真实值;所有字段含父级必须写 desc,父级需显式声明。例如:{"key":"data","desc":"返回体","type":"object"},{"key":"data.user","desc":"用户","type":"object"},{"key":"data.user.id","desc":"用户ID","type":"integer","example":1}
| Name | Required | Description | Default |
|---|---|---|---|
| target_id | Yes | 要修改的接口ID | |
| name | No | 新的接口名称(可选) | |
| method | No | 新的HTTP方法(可选) | |
| url | No | 新的接口URL(可选) | |
| description | No | 接口详细描述(可选)。提供空字符串""可清空描述 | |
| headers | No | Headers参数JSON数组字符串(可选)。提供"[]"可删除所有headers。格式:[{"key":"Content-Type","desc":"内容类型","type":"string","required":true,"example":"application/json"}] | |
| query | No | Query参数JSON数组字符串(可选)。提供"[]"可删除所有query参数。格式:[{"key":"page","desc":"页码","type":"integer","required":false,"example":"1"}] | |
| body | No | Body参数JSON数组字符串(可选)。提供"[]"可删除所有body参数。格式:[{"key":"name","desc":"用户名","type":"string","required":true,"example":"张三"}] | |
| cookies | No | Cookies参数JSON数组字符串(可选)。提供"[]"可删除所有cookies。格式:[{"key":"session_id","desc":"会话ID","type":"string","required":false,"example":"abc123"}] | |
| auth | No | 认证配置JSON字符串(可选)。提供"{}"可删除认证配置。格式:{"type":"bearer","bearer":{"key":"your_token"}} | |
| responses | No | 响应示例JSON数组字符串(可选)。提供"[]"可删除所有响应示例。格式:[{"name":"成功响应","status":200,"data":{"code":0},"fields":[{"key":"code","desc":"状态码","type":"integer","example":"0"}]}] |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. While it mentions that the tool modifies API documentation, it doesn't describe what happens on success/failure, whether changes are reversible, permission requirements, rate limits, or what the response looks like. The formatting rules provided are helpful but don't constitute comprehensive behavioral transparency for a mutation 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 relatively concise but front-loads formatting rules rather than the core purpose. While the formatting guidance is important, it dominates the description at the expense of other critical information. The single paragraph structure could be improved with clearer separation between purpose, usage, and formatting requirements.
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 mutation tool with 11 parameters, no annotations, and no output schema, the description is incomplete. It focuses heavily on formatting rules but neglects behavioral aspects like error handling, success responses, authentication requirements, and side effects. The description doesn't adequately compensate for the lack of structured metadata about this complex update operation.
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 100% schema description coverage, the schema already documents all 11 parameters thoroughly. The description adds some value by providing formatting examples and clarifying that certain parameters can be cleared with empty values, but doesn't significantly enhance understanding beyond what the schema provides. The baseline of 3 is appropriate when the schema does the heavy lifting.
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 verb ('修改' meaning 'modify') and resource ('API接口文档' meaning 'API interface documentation'), making the purpose immediately understandable. However, it doesn't explicitly differentiate this update tool from potential siblings like 'apipost_detail' or 'apipost_smart_create', which might also involve API documentation operations.
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 guidance on when to use this tool versus alternatives. It mentions '规则同创建' (rules same as creation), which implies a relationship with creation tools but doesn't specify when to choose update over creation or other siblings. There's no mention of prerequisites, error conditions, or typical use cases.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
apipost_workspaceC
工作空间管理:查看当前工作空间、列出团队和项目、切换工作空间
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | 操作类型:current(查看当前)、list_teams(列出团队)、list_projects(列出项目)、switch(切换工作空间) | |
| team_id | No | 团队ID(用于list_projects或switch) | |
| project_id | No | 项目ID(用于switch) | |
| team_name | No | 团队名称(用于按名称切换) | |
| project_name | No | 项目名称(用于按名称切换) | |
| show_details | No | 是否显示详细信息,默认false | |
| show_all | No | 是否显示所有可用的团队和项目,默认false |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden for behavioral disclosure. It lists actions but doesn't explain what 'view current workspace' returns, how 'list teams/projects' is paginated or formatted, what 'switch workspace' actually changes in the session, or any authentication/permission requirements. For a multi-action tool with potential session state changes, this leaves significant behavioral gaps.
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 efficiently structured as a single Chinese sentence that lists the four available actions. It's appropriately sized and front-loaded with the tool's purpose. However, it could be slightly more structured by separating the general purpose from the specific actions.
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 7-parameter tool with no annotations and no output schema, the description is incomplete. It doesn't explain what the tool returns for each action type, how the actions affect session state (particularly 'switch'), or provide any error handling context. The combination of multiple actions with different parameter requirements needs more contextual explanation than provided.
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 100%, with all 7 parameters well-documented in the schema itself. The description doesn't add any parameter semantics beyond what's already in the schema - it doesn't explain parameter relationships (e.g., team_id required for certain actions) or provide usage examples. Baseline 3 is appropriate when the schema does the heavy lifting.
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's purpose: '工作空间管理:查看当前工作空间、列出团队和项目、切换工作空间' (Workspace management: view current workspace, list teams and projects, switch workspace). It specifies the verb+resource combination and lists the four specific actions available. However, it doesn't explicitly differentiate this multi-action workspace management tool from its siblings like 'apipost_list' or 'apipost_detail', which might have overlapping functionality.
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 guidance on when to use this tool versus alternatives. It doesn't mention any prerequisites, context for choosing between the four actions, or how this workspace management tool relates to sibling tools like 'apipost_list' or 'apipost_detail'. The user must infer usage from the action list alone.
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. Dates show when Glama detected each change.
4 tool updates
v1.0.0- Changed
apipost_create_folder1 field changed- added
Input schema / additionalPropertiesAdded value: +false
- Changed
apipost_detail1 field changed- added
Input schema / additionalPropertiesAdded value: +false
- Changed
apipost_smart_create6 fields changed- added
Input schema / additionalPropertiesAdded value: +false - changed
Input schema / properties / body / descriptionPrevious value: -"Body参数JSON数组字符串(可选)。格式:[{\"key\":\"name\",\"desc\":\"用户名\",\"type\":\"string\",\"required\":true,\"example\":\"张三\"}]"New value: +"Body字段列表字符串,仅用字段列表生成 raw/参数描述,example 用真实值,不要放 JSON 字符串。" - changed
Input schema / properties / cookies / descriptionPrevious value: -"Cookies参数JSON数组字符串(可选)。格式:[{\"key\":\"session_id\",\"desc\":\"会话ID\",\"type\":\"string\",\"required\":false,\"example\":\"abc123\"}]"New value: +"Cookies字段列表字符串,格式同上。" - changed
Input schema / properties / headers / descriptionPrevious value: -"Headers参数JSON数组字符串(可选)。格式:[{\"key\":\"Content-Type\",\"desc\":\"内容类型\",\"type\":\"string\",\"required\":true,\"example\":\"application/json\"}]"New value: +"Headers字段列表字符串,格式:[{\"key\":\"X-Request-ID\",\"type\":\"string\",\"required\":false,\"example\":\"req-1\",\"desc\":\"说明\"}]" - changed
Input schema / properties / query / descriptionPrevious value: -"Query参数JSON数组字符串(可选)。格式:[{\"key\":\"page\",\"desc\":\"页码\",\"type\":\"integer\",\"required\":false,\"example\":\"1\"}]"New value: +"Query字段列表字符串,格式同上。嵌套用 .,数组用 [](如 meta.flags.debug 或 items[].id)。" - changed
Input schema / properties / responses / descriptionPrevious value: -"响应示例JSON数组字符串(可选)。格式:[{\"name\":\"成功响应\",\"status\":200,\"data\":{\"code\":0},\"fields\":[{\"key\":\"code\",\"desc\":\"状态码\",\"type\":\"integer\",\"example\":\"0\"}]}]"New value: +"响应字段列表字符串(必填 fields),格式:[{\"name\":\"成功\",\"status\":200,\"fields\":[{\"key\":\"code\",\"type\":\"integer\",\"example\":0,\"desc\":\"状态码\"},{\"key\":\"data.items[].id\",\"type\":\"string\",\"example\":\"1\"}]}]"
- Changed
apipost_update1 field changed- added
Input schema / additionalPropertiesAdded value: +false
8 tool updates
- First observed
apipost_create_folder - First observed
apipost_delete - First observed
apipost_detail - First observed
apipost_list - First observed
apipost_smart_create - First observed
apipost_test_connection - First observed
apipost_update - First observed
apipost_workspace
TDQS
Each tool has a clearly distinct purpose with no overlap: folder creation, deletion, detail viewing, listing, smart creation, connection testing, updating, and workspace management. The descriptions clearly differentiate their functions, making misselection unlikely.
All tools follow a consistent 'apipost_verb_noun' pattern with snake_case throughout (e.g., apipost_create_folder, apipost_detail, apipost_test_connection). This predictability makes the tool set easy to navigate and understand.
With 8 tools, this server is well-scoped for API documentation management. Each tool earns its place by covering essential operations like CRUD for API docs, workspace handling, and connection testing, without being overly sparse or bloated.
The tool set provides strong coverage for API documentation management, including create, read, update, delete, list, and workspace operations. A minor gap is the lack of a tool for moving or copying API docs between folders, but agents can work around this using existing tools.
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
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
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.
The Cortex MCP server provides read-only access to real-time engineering context from the Cortex developer portal, allowing AI coding assistants to answer natural language questions about your organization's catalog (microservices, libraries, domains, teams, infrastructure), scorecards (engineering standards and best practices), initiatives (goals and deadlines), and Engineering Intelligence metrics. It includes tools for querying documentation, tracking personal entities, and accessing AI-assisted insights across the entire Cortex ecosystem.
Related MCP Servers
AlicenseNot gradedqualityFmaintenanceA server that connects AI coding assistants like Cursor and Cline to Apifox API definitions, allowing developers to implement API interfaces through natural language commands.1,02294ISC- AlicenseNot gradedqualityDmaintenanceA server that enables accessing and managing ApiFox API information through the Model Context Protocol, supporting both HTTP services and CLI commands.573ISC
- -licenseCqualityNot gradedmaintenanceA Model Context Protocol server with GitHub API integration that enables interaction with repositories, issues, pull requests, and file management through a standardized interface.1-
- AlicenseBqualityDmaintenanceA Model Context Protocol server that allows AI development tools like Cursor and Claude Desktop to retrieve detailed YAPI interface information by interface ID.1179MIT
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/jlcodes99/apipost-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server