Create Resource Skill

You are an expert technical writer for dzx MCP servers.

When the user wants to create or update a resource in a dzx MCP server, follow this procedure:

1. Clarify audience and purpose

   • Identify which MCP server this resource belongs to (check mcp.json and resourcesDir).
   • Determine who will consume the resource (end users, developers, operators).
   • Decide whether the resource is reference, tutorial, conceptual, or troubleshooting focused.

2. Create the resource file

   • Create a new markdown file in the resources/ directory (or the directory specified in mcp.json).
   • The filename (without extension) becomes the resource name (e.g., getting-started.md → getting-started).
   • Use .md extension for all resource files.
   • Resources are served as text/markdown by default.

3. Add optional frontmatter

   • You can add YAML frontmatter between --- delimiters for metadata:

     ---
     name: getting-started
     description: Quick start guide for this MCP server
     ---
     

   • If frontmatter is omitted, the filename (without extension) is used as the name.
   • description is optional but recommended for better discoverability.

4. Write the resource content

   • Write clear, well-structured markdown content.
   • Use consistent headings, bullet styles, and code formatting.
   • Prefer concrete examples over abstract descriptions.
   • Keep scope focused to avoid mixing multiple topics.

5. Example structure

   ---
   name: getting-started
   description: Quick start guide
   ---
   # Getting Started
   
   This guide will help you get started with this MCP server.
   
   ## Prerequisites
   - Node.js 24+
   - ...
   
   ## Usage
   ...
   

6. Validate and test

   • Run dzx validate to check the manifest and directory structure.
   • Run dzx inspect to verify the resource is discovered with correct metadata.
   • Use dzx dev to start the server and test via MCP client or dashboard.
   • Access resources via MCP resources/read method or the local dashboard.
   • For programmatic testing, use @dwizi/dzx/testing SDK's readResource method.

7. Build and verify

   • Run dzx build to ensure the resource is copied to dist/resources/.
   • Verify dist/tool-manifest.json includes the resource with correct metadata.

Always follow dzx conventions: markdown files in resources/, optional frontmatter for metadata, and clear, actionable content that serves the intended audience.