← Back to Skills Marketplace
athola

Nm Cartograph Class Diagram

by athola · GitHub ↗ · v1.0.0 · MIT-0
cross-platform ✓ Security Clean
84
Downloads
0
Stars
1
Active Installs
1
Versions
Install in OpenClaw
/install nm-cartograph-class-diagram
Description
Generate class diagrams showing classes, interfaces, inheritance, and composition
README (SKILL.md)

Night Market Skill — ported from claude-night-market/cartograph. For the full experience with agents, hooks, and commands, install the Claude Code plugin.

Class Diagram

Generate a Mermaid class diagram showing types, their relationships, and public interfaces from a codebase.

When To Use

  • Understanding class hierarchies and inheritance
  • Documenting public APIs of a module
  • Analyzing composition vs. inheritance patterns
  • Answering "what types exist and how do they relate?"

Workflow

Step 1: Explore the Codebase

Dispatch the codebase explorer agent:

Agent(cartograph:codebase-explorer)
Prompt: Explore [scope] and return a structural model.
Focus on classes, dataclasses, protocols, type aliases,
inheritance, and composition for a class diagram.
Extract: class names, methods (public only), attributes,
parent classes, and composed types.

Step 2: Generate Mermaid Syntax

Transform the structural model into a Mermaid class diagram.

Rules for class diagrams:

  • Use classDiagram diagram type
  • Show only public methods and key attributes
  • Use Mermaid relationship notation:
    • \x3C|-- for inheritance
    • *-- for composition
    • o-- for aggregation
    • ..> for dependency/usage
  • Add stereotypes for special types:
    • \x3C\x3Cprotocol>> for Python protocols/interfaces
    • \x3C\x3Cdataclass>> for dataclasses
    • \x3C\x3Cenum>> for enums
    • \x3C\x3Cabstract>> for abstract classes
  • Limit to 12-15 classes maximum
  • Group related classes with namespace
  • Omit private methods and dunder methods
  • Show return types for methods

Example output:

classDiagram
    class ResumeSession {
        +Path config_path
        +dict data
        +load() ResumeSession
        +to_pdf(Path) Path
        +to_html(Path) Path
    }

    class ResumeError {
        \x3C\x3Cabstract>>
        +str message
        +str context
    }

    class ValidationError {
        +list~str~ fields
    }

    class RenderError {
        +str template
    }

    ResumeError \x3C|-- ValidationError
    ResumeError \x3C|-- RenderError
    ResumeSession ..> ResumeError

Step 3: Render via MCP

Call the Mermaid Chart MCP to render:

mcp__claude_ai_Mermaid_Chart__validate_and_render_mermaid_diagram
  prompt: "Class diagram of [scope]"
  mermaidCode: [generated syntax]
  diagramType: "classDiagram"
  clientName: "claude-code"

If rendering fails, fix syntax and retry (max 2 retries).

Step 4: Present Results

Show the rendered diagram with analysis notes:

  • Total classes and relationship count
  • Key inheritance hierarchies identified
  • Composition patterns noted
Usage Guidance
This skill appears coherent and does what it says: it will examine your codebase (via a codebase-explorer agent) to extract types/relationships and then send generated Mermaid code to the platform's Mermaid Chart renderer. Before installing or running it on private repositories, confirm you are comfortable granting the agent read access to the repository and that sending diagram content to the platform renderer is acceptable for your data sensitivity. Avoid embedding secrets or sensitive tokens in code snippets you expect the tool to analyze; if you need stricter privacy, run an offline or self-hosted diagramming workflow instead.
Capability Analysis
Type: OpenClaw Skill Name: nm-cartograph-class-diagram Version: 1.0.0 The skill is a standard utility for generating Mermaid class diagrams from a codebase. It defines a clear workflow involving a codebase exploration step and rendering via a dedicated Mermaid Chart MCP tool. No indicators of data exfiltration, malicious execution, or harmful prompt injection were found in SKILL.md or _meta.json.
Capability Assessment
Purpose & Capability
Name/description (generate class diagrams) matches the instructions: explore a codebase, extract types/relationships, generate Mermaid, and render. No unrelated binaries, env vars, or installs are requested.
Instruction Scope
Instructions explicitly dispatch a 'codebase-explorer' agent to read the codebase and then call a Mermaid Chart MCP to render the diagram. Reading repository files and sending generated mermaid code to a rendering service are expected for this purpose, but they do mean the skill will access source files and transmit diagram data to the platform renderer.
Install Mechanism
Instruction-only skill with no install steps or downloaded code. Lowest-risk install posture.
Credentials
No environment variables, credentials, or config paths are requested; the declared requirements are proportional to the stated functionality.
Persistence & Privilege
No 'always: true' or other elevated persistence requested. The skill is user-invocable and does not request system-wide changes.
How to Use
  1. Make sure OpenClaw is installed (local or Docker)
  2. Run the install command in chat: /install nm-cartograph-class-diagram
  3. After installation, invoke the skill by name or use /nm-cartograph-class-diagram
  4. Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial release of the class-diagram skill: - Generates Mermaid class diagrams from codebase structure. - Highlights classes, interfaces (protocols), inheritance, and composition. - Follows clear rules for public methods, key attributes, and relationships. - Integrates with codebase explorer and a diagram rendering step. - Limits diagrams to 12–15 classes for clarity. - Adds stereotypes for protocols, dataclasses, enums, and abstract classes.
Metadata
Slug nm-cartograph-class-diagram
Version 1.0.0
License MIT-0
All-time Installs 1
Active Installs 1
Total Versions 1
Frequently Asked Questions

What is Nm Cartograph Class Diagram?

Generate class diagrams showing classes, interfaces, inheritance, and composition. It is an AI Agent Skill for Claude Code / OpenClaw, with 84 downloads so far.

How do I install Nm Cartograph Class Diagram?

Run "/install nm-cartograph-class-diagram" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.

Is Nm Cartograph Class Diagram free?

Yes, Nm Cartograph Class Diagram is completely free, licensed under MIT-0. You can download, install and use it at no cost.

Which platforms does Nm Cartograph Class Diagram support?

Nm Cartograph Class Diagram is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).

Who created Nm Cartograph Class Diagram?

It is built and maintained by athola (@athola); the current version is v1.0.0.

💬 Comments