Config Generator Guide

This guide helps you understand how to use the UI config generator for the API MCP Server — a lightweight, extensible server for defining and executing HTTP API tools using the MCP protocol.

What is the UI Config Generator?

The UI config generator allows you to visually create JSON tool definitions for the server. These tools define API endpoints, arguments, headers, and request behavior in a way that the MCP server can execute dynamically.

Getting Started

On the left sidebar, you'll see a group labeled Tools. This section allows you to manage your custom tools visually.

  • Click the + icon next to the Tools label to create a new tool.
  • The new tool will appear in the list immediately below.
  • The or icon next to each tool indicates whether its definition is valid.
  • Hover over any tool to reveal the ... menu, which gives you the option to delete that tool.

Environment Placeholders

Use the syntax {{env VAR_NAME:default}} anywhere you want to inject environment values (e.g., host, headers, etc).

Tool Editor Sections

Each tool is divided into four main sections, presented as collapsible accordions:

General

Define the tool’s Name and Description.

Request

Configure the API request that will be executed by the api-mcp-server.

Args

Arguments are values provided by the LLM and map to the tool’s pathParams, queryParams, or body.

When a path or query parameter is defined, a corresponding argument field is auto-generated in the UI.

Result

Live JSON preview of the final generated configuration.

Notes

Path Parameters

If a value prefixed with a colon (e.g., :name) appears exactly in the endpoint field, it is automatically extracted as a path parameter and generates a corresponding argument in the Args section.

For example, if your endpoint is:

/api/v1/users/:name

An argument will be created for the "name" path parameter.

Query Parameters

Query parameters are specified as comma-separated values in the Query Params field inside the request section. For each parameter listed here, a corresponding argument is generated in the Args section.

The api-mcp-server automatically constructs the full request URL by appending these query parameters with their provided values.

Note that static query parameters included directly in the endpoint URL (e.g., ?name=adam) are treated as fixed values and do not generate arguments. Any additional query parameters from the Query Params field will simply be appended to the URL.

Request Body

The body field in the request configuration does not represent the actual raw request payload. Instead, it specifies the name of the argument that the LLM will provide.

Exporting and Importing Configs

At the bottom of the sidebar, you’ll find two actions:

  • Export: Downloads your current configuration as a JSON file containing all defined tools.
  • Import: Uploads a JSON file to replace your current tools. Note: This will overwrite all existing tools.

Examples