Refactoring

You set up a dedicated MCP server built on the MCP SDK to generate and manage Refactoring protocol and governance prompts over HTTP and CLI workflows. It provides a stable, automation-friendly way to create, validate, and store prompt payloads for downstream tooling.

How to use

Start the MCP server locally and use the available tools to build, validate, and store prompts. You can publish prompts via the HTTP API or leverage the built-in CLI-style tools to generate and manage prompt records. After starting, you should be able to POST a protocol or governance prompt and retrieve it by its id to verify the payload contains the expected text and metadata.

How to install

Prerequisites: ensure you have Node.js installed (LTS version recommended). You will also use npm to install and start the MCP server.

npm install -g refactoring-mcp

# Or install locally for a project
npm install refactoring-mcp

# Start the MCP server (defaults to port 3000)
refactoring-mcp

# If you prefer starting via npm script
npm start

# Optional: override listening port
refactoring-mcp --port 4000

Notes and usage tips

The server exposes an HTTP API for prompt management and a set of tools to generate and inspect prompts. Use the start command to bring the service online, then interact with the API to post and fetch prompt definitions.

Additional content

Configuration and runtime details you may need include:

- The server runs as a standalone process and can be started with `refactoring-mcp` or `npm start`.
- Default port is 3000, adjustable with `--port`, `-p`, or the `PORT` environment variable.
- The server provides tools to list documents, fetch a document by key, download a bundle of documents, generate a prompt, and list or retrieve saved prompts.
- Environment variables are supported and can be reflected in the server config as needed (example: `PORT=3000`).

When you publish a new prompt, store and verify it by retrieving it with its id to ensure both the text and metadata are returned.

Available tools

service_status

Return service metadata (name, version, uptime, timestamp) to help agents monitor the running MCP server.

refactoring_mcp_list_documents

List all guidance documents that describe the MCP prompts and governance templates available in this server.

refactoring_mcp_get_document

Fetch a specific guidance document by its key, enabling quick access to template content.

refactoring_mcp_get_bundle

Download all guidance documents in a single bundle for offline or bulk review.

refactoring_mcp_generate_prompt

Build a protocol or governance prompt, validate its schema, and store the payload for later use by automation.

refactoring_mcp_list_prompts

Inspect saved prompt metadata and timestamps to understand what has been created and when.

refactoring_mcp_get_prompt

Retrieve a stored prompt by its unique id to examine its text and associated metadata.