openapi-modifier-mcp
v1.0.2
Published
MCP server for working with OpenAPI Modifier rules
Maintainers
Readme
🇺🇸 English | 🇷🇺 Русский | 🇨🇳 中文
OpenAPI Modifier MCP Server
MCP (Model Context Protocol) server for working with openapi-modifier rules and configurations.
Installation
cd mcp
npm install
npm run buildConfiguration in Cursor
Add to .cursor/mcp.json (or MCP settings):
{
"mcpServers": {
"openapi-modifier": {
"command": "npx",
"args": [
"openapi-modifier-mcp"
],
"env": {
"LANG": "en"
}
}
}
}Note: The
LANGenvironment variable determines the default documentation language (en,ru,zh). If not specified,enis used.
Configuration in Claude Desktop
Add to the Claude Desktop configuration file:
macOS:
~/Library/Application Support/Claude/claude_desktop_config.jsonWindows:
%APPDATA%\Claude\claude_desktop_config.jsonLinux:
~/.config/Claude/claude_desktop_config.jsonConfiguration:
{
"mcpServers": {
"openapi-modifier": {
"command": "npx",
"args": [
"openapi-modifier-mcp"
],
"env": {
"LANG": "en"
}
}
}
}After adding the configuration, restart Claude Desktop.
Note: The
LANGenvironment variable determines the default documentation language (en,ru,zh). If not specified,enis used.
Configuration in Roo
Add to the Roo configuration file:
macOS:
~/Library/Application Support/Roo/roo_config.jsonWindows:
%APPDATA%\Roo\roo_config.jsonLinux:
~/.config/Roo/roo_config.jsonConfiguration:
{
"mcpServers": {
"openapi-modifier": {
"command": "npx",
"args": [
"openapi-modifier-mcp"
],
"env": {
"LANG": "en"
}
}
}
}After adding the configuration, restart Roo.
Note: The
LANGenvironment variable determines the default documentation language (en,ru,zh). If not specified,enis used.
Tools
- list_rules — returns a list of all available openapi-modifier rules with their brief descriptions. Supports the
langparameter for selecting documentation language (en, ru, zh). - get_rule_config — gets the configuration description for a specific rule. Supports the
langparameter for selecting documentation language (en, ru, zh). - get_simple_text_file_modifier_doc — gets the Simple Text File Modifier cli documentation (adding text to the beginning/end of a file, replacement by regular expressions). Supports the
langparameter for selecting documentation language (en, ru, zh).
Development
npm run build # build TypeScript to JavaScriptAfter building, the server is ready to use. Use the path to dist/index.js in the MCP configuration to run it.
Development Setup
For development, you can use the local build:
{
"mcpServers": {
"openapi-modifier": {
"command": "node",
"args": ["/path/to/openapi-modifier/mcp/dist/index.js"],
"env": {
"LANG": "en"
}
}
}
}Structure
mcp/
├── docs/
│ ├── rules.md # list of rules (source for list_rules)
│ ├── rules-ru.md
│ └── rules-zh.md
├── resources/
│ └── rules.json # list of available rules
├── src/
│ └── index.ts
├── dist/ # after npm run build
├── package.json
├── tsconfig.json
└── README.mdLanguages
The server supports three documentation languages: en (default), ru, zh. The default language is determined from the LANG environment variable or set to en if the variable is not set or contains an unsupported value.
