ApiPost

ApiPost API management tool based on MCP (Model Context Protocol), supporting complete interface documentation management and team collaboration. Features intelligent search, batch operations, and security management.

javascript

GitHub Stars

javascript

Language

4 months ago

First Indexed

3 weeks ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "jlcodes99-apipost-mcp": {
      "command": "node",
      "args": [
        "/absolute/path/to/apipost-mcp/dist/index.js"
      ],
      "env": {
        "APIPOST_HOST": "https://open.apipost.net",
        "APIPOST_TOKEN": "your_token_here",
        "APIPOST_URL_PREFIX": "{{host}}",
        "APIPOST_SECURITY_MODE": "limited",
        "APIPOST_DEFAULT_TEAM_NAME": "Your Team",
        "APIPOST_DEFAULT_PROJECT_NAME": "Your Project"
      }
    }
  }
}

ApiPost MCP provides a practical way to manage APIs using the MCP protocol with ApiPost’s official OpenAPI integration. It enables you to test connections, organize workspaces, manage API directories and interfaces, perform granular updates, and regulate access with flexible security modes.

How to use

You interact with the ApiPost MCP server through an MCP client to manage API documents and operations. Start by testing the MCP connection, then set your default workspace (team and project) to match your organization. Create folders to organize APIs, add or modify API documents, and use multi-criteria search to locate items quickly. You can recursively browse subdirectories, group results, and view full paths to quickly locate any API document. Apply appropriate security modes to control what actions you can perform, such as viewing only, reading/writing, or full access.

How to install

Prerequisites you need before installing: Node.js >= 18.0.0 and npm >= 8.0.0. You should have a working environment for JavaScript execution and package management.

# Node.js and npm should already be installed as part of your environment setup
node --version   # should be v18.0.0 or higher
npm --version    # should be 8.0.0 or higher

# Start by cloning the project, installing dependencies, and building
git clone https://github.com/jlcodes99/apipost-mcp.git
cd apipost-mcp
npm install && npm run build

Additional setup notes

Configuration for the MCP server is provided as a JSON block to define how the server runs and which environment variables it uses.

Configure the MCP server

{
  "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}}"
      }
    }
  }
}

Security modes

你可以在以下安全模式之间进行选择：只读 readonly 仅允许查看接口列表和详情，禁止创建、修改、删除；读写 limited 允许查看、创建、修改接口，禁止删除；完全访问 full 允许查看、创建、修改、删除所有操作。

Environment variables note

需要在运行时提供以下环境变量。你可以将它们放入 MCP 配置的 env 区段，也可以通过系统环境变量暴露。

Available tools

apipost_test_connection

快速诊断工具，用于验证 MCP 服务器连接状态、环境变量配置、工作空间信息和权限设置

apipost_workspace

统一的工作空间管理工具，支持查看当前、列出团队、列出项目以及切换工作空间

apipost_create_folder

在指定父目录下创建新的文档目录，支持根目录与子目录创建

apipost_smart_create

基于字段驱动的接口创建工具，按字段列表描述接口、请求头、查询参数、请求体和响应字段等信息

apipost_list

强化的列表搜索，支持关键词、分组显示、树形结构、递归和深度控制

apipost_detail

查看选定接口或目录的详细信息

apipost_update

修改接口文档的属性与字段，支持精确更新

apipost_delete

删除接口或文档条目

Built by

VeilStrat

AI signals for GTM teams