Api.market

🚀 API-MCP Server Development Guide

This guide provides a comprehensive overview of installing, configuring, and using the API-MCP server. It also includes details on adding new APIs, command-line parameters, debugging, and contribution guidelines.

🚀 Quick Start

📦 Installation

1. Clone the repository and install the required packages:

git clone https://github.com/Noveum/api-market-mcp-server.git
cd api-market-mcp-server
npm install

2. After installation, start the development environment:

npm run dev

⚙️ Configuration

Required Configuration Items

• apiBaseUrl: The root URL of the API service, with a default value of https://api.magicapi.dev/api/v1/
• openapiSpec: The path to the folder containing OpenAPI specification files, with a default value of ./json_files

Optional Configuration Items

• headers: Request header information in the format key:value, e.g., x-magicapi-key:your_api_key
• name: The name of the MCP service, with a default value of default-mcp-server
• version: The version number of the MCP service, with a default value of 1.0.0

💻 Usage Examples

Example 1

We can use the proxy to find routes between any two points.

Example 2

We can use the proxy to find news on any topic and then delve into related articles.

Example 3

We can use the proxy to find available domain names.

📚 Documentation

Adding a New API to the MCP Server

The utils folder contains helper scripts for managing API configurations, parsing OpenAPI specifications, and registering new APIs.

1. Obtain the OpenAPI Specification

Find the OpenAPI JSON file for the API you want to integrate. Create a folder named json_files in the project root directory and place the obtained OpenAPI JSON file in it.

2. Modify the OpenAPI Specification

Use the modify_api.py script to update the paths in the specification to include the file name:

python utils/modify_api.py

3. Update the API Summary

After modifying the paths, update the API summary. You can choose one of the following two methods:

• Automatically shorten the summary (using LLM):

  python utils/LLM_summary_shortener.py 
  

• Manually update the summary:

  python utils/manual_summary_shortener.py 
  

4. Build and Test

Rebuild the project to apply the changes:

npm run build

Then test the new API integration using the following command:

npm run inspect

5. Submit Code Changes

If you wish to contribute the new API to the repository:

• Fork the repo.
• Create a feature branch.
• Commit the changes and create a pull request (PR).

6. Publish the MCP Server (Optional)

If you want to publish the changes:

• Update the package.json file (e.g., update the version number, name, etc.).
• Publish the package:

  npm publish --access public
  

🔧 Technical Details

Command-Line Parameters

Start Command

npm run start

Configuration File Path

Start the MCP server by adding the following configuration to package.json:

"scripts": {
  "start": "mcp-server --apiBaseUrl https://your_api_base_url --openapiSpec ./specs"
}

Debugging Information

Print Logs

You can view real-time logs through the console:

npm run start

🤝 Contribution Guidelines

• Report Issues: Submit issues to the Issues page
• Contribute Code: Submit pull requests to the GitHub repository

⚠️ Important Note

All code examples and command-line statements are in UTF-8 encoding. Please ensure you run them in an environment that supports UTF-8.