@demoway/mcp-server

by DemoWayOfficial

243 downloads
Not rated
GitHub

About

@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…

Details

Author
DemoWayOfficial
Downloads
243
Categories
Other

- 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

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name @demoway/mcp-server
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

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.

search_demo_step

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.

download_demo_step_pretty_html

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.

capture_page_prompt

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.

import_page_prompt

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.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

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

McpServers

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

@demoway/mcp-server

[![npm package][npm-img]][npm-url] [![Downloads][downloads-img]][downloads-url] [![Issues][issues-img]][issues-url] [![Commitizen Friendly][commitizen-img]][commitizen-url]

DemoWay MCP server implementation providing standardized Model Context Protocol (MCP) interface services.

Available Tools

- search_demo_step: Search step by keyword in a demo
- download_demo_step_pretty_html: Download demo's step pretty html

Usage

Configuration

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

Local Development

1. Install tsx globally

pnpm --global install tsx

2. Configure MCP client

{
  "mcpServers": {
    "demoway": {
      "command": "tsx",
      "args": ["<ABSOLUTE_PATH_TO_SRC_INDEX_FILE>", "--url=http://localhost:3333"],
      "env": {
        "DEMOWAY_API_KEY": "<YOUR_API_KEY>"
      }
    }
  }
}

Contributing

Pull requests are welcome. Please ensure:

1. Code follows ESLint rules
2. Add appropriate test cases
3. Use Commitizen for commit messages

License

MIT © DemoWay

[downloads-img]: https://img.shields.io/npm/dt/@demoway/mcp-server
[downloads-url]: https://www.npmtrends.com/@demoway/mcp-server
[npm-img]: https://img.shields.io/npm/v/@demoway/mcp-server
[npm-url]: https://www.npmjs.com/package/@demoway/mcp-server
[issues-img]: https://img.shields.io/github/issues/DemoWayOfficial/mcp-server
[issues-url]: https://github.com/DemoWayOfficial/mcp-server/issues
[commitizen-img]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
[commitizen-url]: http://commitizen.github.io/cz-cli/

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.