Introduction

When creating technical documentation or architecture diagrams, developers frequently need to consult Mermaid diagram grammar specifications. Manual searching is not only time-consuming but can also lead to documentation errors due to version differences. The DeepSeek Harness (DSH) plugin ecosystem aims to solve this kind of integration issue by providing out-of-the-box capabilities. The xby-mermaid-doc plugin is introduced below.

Plugin Overview

  • Name: xby-mermaid-doc
  • Maintainer: xby-skill
  • Category: Online Tool
  • Core Description: Mermaid Doc MCP Server is a server for generating Mermaid documentation, providing the ability to list available diagrams and retrieve documentation for specific diagrams.
  • License: MIT

Core Features

The plugin provides two main tools through the MCP (Model Context Protocol):

  1. set_xby_apikey
    Sets the API key in the chat. This action is automatically persisted and remains valid after the DSH process is restarted.

  2. get_diagram_doc
    Retrieves the documentation content for a specific Mermaid diagram.
    * Parameter: diagram_name (DiagramType)
    * Return Value: string (str)

Installation and Activation

It is recommended to install it using the officially provided command:

dsh plugin --profile web add github:xby_skill/xby-mermaid-doc

After installation, the plugin becomes active in the corresponding Profile (e.g., web). For local development and debugging, you can also install it using an absolute path:

dsh plugin --profile web add /absolute/path/to/xby-mermaid-doc

Configuration and Usage

Get the Key: Before use, you need to register on the Xiaobenyang official website and obtain an API key.

Invocation Example: When calling get_diagram_doc in the chat, you must pass the specific diagram type name. Supported diagram types include but are not limited to: architecture, block, c4, classDiagram, entityRelationshipDiagram, examples, flowchart, gantt, gitgraph, kanban, mindmap, packet, pie, quadrantChart, radar, requirementDiagram, sankey, sequenceDiagram, stateDiagram, timeline, userJourney, xyChart, zenuml.

Notes

  1. Case-sensitive Parameters: The diagram_name parameter is case-sensitive.
  2. Query Result: If no diagram is found, an empty string is returned.
  3. External Service Dependency: An API key must be obtained from the Xiaobenyang official website.

Conclusion

By encapsulating the Mermaid documentation retrieval logic, this plugin lowers the barrier to writing technical documentation in the DSH environment. For more details, see the GitHub repository or the community catalog.