Api Market MCP Server

🚀 API-MCP Server

The API-MCP Server is a powerful tool that allows you to integrate and manage various APIs efficiently.

🚀 Quick Start

📦 Installation

To install and run the API-MCP Server, follow these steps:

Install using npm

npm install -g @magicapi/mcp-server

Start the server

mcp-server --api-base-url https://api.magicapi.dev/api/v1/ --headers "x-magicapi-key:your-api-key"

Example commands

Example 1: Run with default configuration

mcp-server

Example 2: Specify API base URL and key

mcp-server --api-base-url https://api.magicapi.dev/api/v1/ --headers "x-magicapi-key:your-api-key"

💻 Usage Examples

🛠️ Development

Add a new API to the MCP Server

Step 1: Locate the OpenAPI specification

Find the OpenAPI JSON file for the API you want to integrate. Then, create a folder named json_files in the project root directory and add your OpenAPI JSON file to this folder.

Step 2: Modify the OpenAPI specification

After obtaining 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

Step 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

Step 4: Build and test

Rebuild the project to apply the changes:

npm run build

Then, test the newly integrated API using the following command:

npm run inspect

Step 5: Submit your changes

If you wish to contribute these changes to the repository:

• Fork the repository.
• Create a feature branch.
• Commit your changes.
• Submit a pull request (PR).

Step 6: Publish the MCP Server (optional)

If you wish to publish your changes:

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

npm publish --access public

🛠️ Development Tools

Build

• npm run build - Build the TypeScript source code.
• npm run clean - Delete build artifacts.
• npm run typecheck - Run TypeScript type checking.

Development mode

• npm run dev - Watch source files and rebuild on changes.
• npm run inspect-watch - Run the inspector with auto-reload.

Code quality

• npm run lint - Run ESLint.
• npm run typecheck - Validate TypeScript types.

Set environment variables:

Configure your environment by running the following commands:

export OPENAPI_SPEC_PATH=modified_files.txt # Optional
export API_BASE_URL=https://api.magicapi.dev/api/v1/ # Optional
export NODE_OPTIONS=--loader ts-node/esm # Optional

🤝 Contribution Guidelines

Submit code

Before submitting your code, make sure to run the following commands:

npm run lint
npm test

Then, commit your changes and create a pull request.

🐞 Debugging or Local Running

Install dependencies

npm install

Start the development server

npm run dev

Access documentation

Visit Documentation for more detailed information.

With the above steps, you can easily install, configure, and use the API-MCP Server, and extend and customize it as needed.