Api Suggestion Server

🚀 API Suggestion Server

API Suggestion Server is a tool based on the MCP protocol that provides API - related context information for AI models (such as Claude and GPT - 4) according to the OpenAPI 3.0 service specification.

🚀 Quick Start

API Suggestion Server enables AI models to obtain API - related context information. You can quickly start using it by following the installation steps below.

✨ Features

• Multi - protocol Support: Supports OpenAPI documents in YAML and JSON formats, as well as documents in URL format.
• Intelligent Suggestions: Provides the most relevant API endpoint suggestions based on the input usage scenarios.
• Easy to Expand: New OpenAPI service specifications can be easily added to the system.

📦 Installation

1. Clone the project repository:

git clone [your-repository-url]
cd api-mcp-server

2. Install dependencies:

npm install

3. Start the server:

npm start

💻 Usage Examples

Adding New Service Specifications

1. Place the OpenAPI service specification file (in YAML or JSON format) in the schemas directory.
2. Add new service configurations in the server.config.ts file.

MCP Protocol Support

AI models can interact with the server by calling the following tools:

suggest_api Tool

Function: Provides API endpoint suggestions related to the specified purpose.

Input Parameters:

• purpose: A description of the purpose of using the API (string)

Output Results:

• A list of relevant API endpoints (including service names, paths, request methods, and description information)

Example Usage:

{
  "name": "suggest_api",
  "arguments": {
    "purpose": "用户信息获取"
  }
}

Example Return:

{
  "toolResult": [
    {
      "service": "示例 API",
      "path": "/users/{userId}",
      "method": "GET",
      "description": "根据 ID 获取指定用户信息"
    },
    {
      "service": "示例 API", 
      "path": "/users",
      "method": "GET",
      "description": "获取所有用户列表"  
    }
  ]
}

📚 Documentation

Configuration

Edit the server.config.ts file to add new service configurations.

Development Guide

Building the Project

npm run build

Testing

1. Run all tests:

npm test

2. Run tests in watch mode (convenient for development):

npm run test:watch

3. Generate a coverage report:

npm run test:coverage

Directory Structure

api-mcp-server/
├── src/
│   ├── index.ts        # Main server code
│   ├── utils.ts        # Utility functions
│   ├── types.ts        # Type definitions
│   └── tests/          # Test files
├── schemas/            # OpenAPI service specification files
├── server.config.ts    # Server configuration
├── tsconfig.json       # TypeScript configuration
└── package.json        # Project dependency management

📄 License

MIT License

💪 Contribution Guide

Welcome to submit issues and contribute code!