MCP.so
Sign In

@demoway/mcp-server

@DemoWayOfficial

About @demoway/mcp-server

Demoway MCP standalone service

Config

Add this server to your MCP-compatible client using the configuration below.

{
  "mcpServers": {
    "demoway": {
      "command": "npx",
      "args": [
        "-y",
        "@demoway/mcp-server@latest"
      ],
      "env": {
        "DEMOWAY_API_KEY": "<YOUR_API_KEY>"
      }
    }
  }
}

Tools

4

Use this tool to get one step from a specific demo which is matched by keyword, match means step content contains or has similar semantic. This tool returns the matched step info in JSON format.

Use this tool to download the corresponding pretty HTML files of pages from https://app.demoway.com/demo/:demoId, https://app.demoway.cn/demo/:demoId to local. This tool returns the downloaded steps list data in JSON format that you can then parse and analyze, each item include follow fields: - "index": Identify the step order in the demo flow. - "stepId": Step unique id in demo flow. - "status": Status of server processing the current step, values includes "NOT_STARTED", "PENDING", "SUCCESS", "ERROR". - "file": local file absolute path of the downloaded current step pretty html file. If neither "stepIds" nor "indexes" are present in the parameters, it means downloading all steps.

When a user requests to download or modify a page from a specific URL, and the URL's domain is not app.demoway.cn or app.demoway.com, use this tool to prompt the user to first use the DemoWay browser extension to capture the page.

Use this tool when users request to import common front-end files (like html, astro, vue, react) to design tools like: Figma, MasterGo, or Pixso, If the user doesn't specify a design tool, ask he first.

Overview

What is @demoway/mcp-server?

@demoway/mcp-server is a Model Context Protocol (MCP) server implementation that provides standardized MCP interface services for DemoWay. It allows AI agents to search and download demo steps via two tools. The server is intended for developers integrating DemoWay content into AI workflows.

How to use @demoway/mcp-server?

Install and configure the server in your MCP client using npm (npx -y @demoway/mcp-server@latest) with a DEMOWAY_API_KEY environment variable and an optional --region flag (world or china). For local development, use tsx to run the source index file with a local server URL.

Key features of @demoway/mcp-server

  • Search for demo steps by keyword using search_demo_step
  • Download a demo step's pretty HTML using download_demo_step_pretty_html
  • Supports two regions: world and china
  • Uses environment variable for API key authentication
  • Easy to run via npx without global install

Use cases of @demoway/mcp-server

  • AI assistants fetching step-by-step demo instructions from DemoWay
  • Automating the retrieval of pretty HTML documentation for demo steps
  • Integrating DemoWay content into chatbots or automated help systems
  • Prototyping and testing DemoWay MCP integrations locally

FAQ from @demoway/mcp-server

What tools does @demoway/mcp-server provide?

It provides two tools: search_demo_step (search steps by keyword) and download_demo_step_pretty_html (download a demo step's pretty HTML).

How do I configure @demoway/mcp-server?

Use the JSON configuration in your MCP client with command: "npx", args: ["-y", "@demoway/mcp-server@latest", "--region={world,china}"], and set DEMOWAY_API_KEY in the env field.

What dependencies or runtime does @demoway/mcp-server require?

It runs via Node.js with the npx command (or tsx for local development). No additional global dependencies are needed for production use.

Where does @demoway/mcp-server get data from?

The server accesses DemoWay's API using the provided DEMOWAY_API_KEY. No local data is used; all data comes from DemoWay's cloud service.

What is the region parameter for?

The --region flag accepts world or china to specify which DemoWay instance to use. This is set in the server arguments.

Frequently asked questions

What tools does @demoway/mcp-server provide?

It provides two tools: `search_demo_step` (search steps by keyword) and `download_demo_step_pretty_html` (download a demo step's pretty HTML).

How do I configure @demoway/mcp-server?

Use the JSON configuration in your MCP client with `command: "npx"`, `args: ["-y", "@demoway/mcp-server@latest", "--region={world,china}"]`, and set `DEMOWAY_API_KEY` in the `env` field.

What dependencies or runtime does @demoway/mcp-server require?

It runs via Node.js with the `npx` command (or `tsx` for local development). No additional global dependencies are needed for production use.

Where does @demoway/mcp-server get data from?

The server accesses DemoWay's API using the provided `DEMOWAY_API_KEY`. No local data is used; all data comes from DemoWay's cloud service.

What is the region parameter for?

The `--region` flag accepts `world` or `china` to specify which DemoWay instance to use. This is set in the server arguments.

Comments

Basic information

Category

Other

License

MIT license

Transports

stdio

Author

DemoWayOfficial

More Other MCP servers