Noveum Api Market MCP Server

🚀 API-Market MCP Server Guide

This guide provides detailed instructions on installing, configuring, and running the API-Market MCP server, as well as guidelines for contributing to the project.

📦 Installation

Install with npm

Run the following command to install the required dependencies:

npm install

Set Environment Variables

Configure environment variables to customize the behavior:

• OPENAPI_SPEC_PATH: Specify the path to the modified file (optional).
• API_BASE_URL: Set the base URL for the API (optional).
• API_HEADERS: Set the request headers, for example:

export API_HEADERS="x-magicapi-key:your-api-key"

Run the Command

Run the following command to start the MCP server:

npm run build

🔧 Environment Variable Configuration

Example Environment Variables

• OPENAPI_SPEC_PATH=modified_files.txt
• API_BASE_URL=https://api.magicapi.dev/api/v1/
• API_HEADERS="x-magicapi-key:your-api-key"

💻 Command-Line Arguments

Usage Example

npm run inspect -- \
  --api-base-url https://api.magicapi.dev/api/v1/ \
  --openapi-spec modified_files.txt \
  --headers "x-magicapi-key:your-api-key" \
  --name "my-mcp-server" \
  --version "1.0.0"

🔨 Development Mode

Start the Development Environment

Run the following command to start the development server:

npm run inspect-watch

Modify the Code

Modify the TypeScript files in the src/ directory, and the server will automatically rebuild and restart.

Use Debugging Tools

• Use the MCP inspector interface to test changes.
• Access http://localhost:9001 through your browser.

🤝 Contribution Guidelines

Submit Code

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes.
4. Run tests and checks:

npm run typecheck
npm run lint

5. Submit a Pull Request.

Publishing Guide (Optional)

If you want to publish a new version:

• Update the relevant information in package.json.
• Publish the package:

npm publish --access public

📄 License

This project is licensed under the MIT License.