Skip to main content
Glama
zhangwanli09

internal-swagger-mcp

by zhangwanli09
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Server Configuration

Describes the environment variables required to run the server.

NameRequiredDescriptionDefault
PORTNoPort for HTTP mode (default 3000)
SOURCES_FILENoPath to a JSON file containing the source list (relative to project root)
MCP_BIND_HOSTNoBind address for HTTP mode (default 0.0.0.0)
SWAGGER_SOURCESNoJSON array of Swagger source URLs (e.g., ["<SOURCE>"])
MCP_BEARER_TOKENNoBearer token for HTTP mode authentication
MCP_ALLOWED_ORIGINSNoComma-separated allowed origins for HTTP mode

Instructions

Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.

This server publishes no instructions, or was last inspected before Glama recorded them.

Capabilities

Features and capabilities supported by this server

Protocol revision2025-11-25

CapabilityDetails
tools
{
  "listChanged": true
}

Tools

Functions exposed to the LLM to take actions

NameDescription
swagger_list_sourcesA

List all configured Swagger documentation sources and their cache status.

For each service, returns:

  • name: Service name (from config, or auto-read from projectName).

  • fetchedAt: Last cache time (null means not yet loaded).

  • totalInterfaces: Total interface count (shown when loaded).

  • modules: Module list.

Use this before calling swagger_search_api to discover which services are available.

swagger_search_apiA

Search API interfaces in the internal Swagger documentation.

Searches by keyword across interface name, description, path, and module name. Optionally filter by HTTP method and service.

Parameters:

  • keyword (required): Search keyword, e.g. "登录", "user", "/api/order". Chinese is supported.

  • method (optional): HTTP method filter, e.g. "GET", "POST".

  • source (optional): Service name filter, taken from swagger_list_sources results.

  • include_deprecated (optional): Whether to include deprecated interfaces. Default false.

  • limit (optional): Maximum number of results. Default 20.

Response: Each matched interface includes: service name, module name, HTTP method, full path, interface name, description, status.

Examples:

  • Search login interfaces: keyword="登录"

  • Search POST interfaces: keyword="用户", method="POST"

  • Search within a specific service: keyword="order", source="订单服务"

swagger_get_api_detailA

Get full details of a single API interface, including all parameter definitions and response examples.

Parameters:

  • source (required): Service name, from the [service name] returned by swagger_list_sources or swagger_search_api.

  • method (required): HTTP method, e.g. "GET", "POST".

  • path (required): Full interface path, e.g. "/qmAuthorityCenter/systemFun/initPerformanceSolution".

Response includes:

  • Basic interface info (name, description, status, Content-Type).

  • Full definitions for Query / Path / Header / Form / Body parameters (name, type, required, description). Required column: "是" = required, "否" = optional, "?" = platform metadata is ambiguous (checkType=1 with no error message — cross-check with backend code or treat as optional).

  • Sub-fields of nested Object parameters.

  • Response results (Demo JSON + output field table).

  • Mock response field table.

swagger_refresh_cacheA

Force-refetch Swagger documentation data and update the cache.

Use this after the documentation has been updated (interfaces added or modified) to fetch the latest data.

Parameters:

  • source (optional): Service name. Omit to refresh all services.

Returns: Refresh results, including success/failure status and updated interface counts.

Prompts

Interactive templates invoked by user choice

NameDescription

No prompts

Resources

Contextual data attached and managed by the client

NameDescription

No resources

Deploy Server
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

TDQS

A4.5/5.0

Scored across 4 tools

Disambiguation5/5

Each tool serves a distinct function: listing sources, searching APIs, fetching details, and refreshing cache. There is no overlap between these operations.

Naming Consistency5/5

All tool names follow the consistent pattern 'swagger_<verb>_<noun>' with lowercase and underscores. The naming is uniform and predictable.

Tool Count5/5

Four tools are well-scoped for a Swagger documentation MCP server, covering the essential operations without unnecessary bloat.

Completeness5/5

The tool surface covers the full workflow: discover sources, search endpoints, get detailed specs, and refresh cached docs. No obvious gaps exist for the stated purpose.

Maintenance

ActivityInactive
ResponsivenessNo issues

Resources