Skip to content

[Module Name] - Claude Context

Note: This module inherits MCP documentation access rules from mcp-docs/claude-code/MCP_STANDARD_RULES.md. If your module uses external documentation, Claude will automatically use MCP Local RAG.

Documentation for This Module

[Only include this section if your module needs specific documentation files]

If asked about [specific topics], the following files should be ingested:

{{DOCS_DIR}}/{{filename1}}.pdf
{{DOCS_DIR}}/{{filename2}}.pdf

Note: These paths are typically relative to the repository root. Claude will automatically construct absolute paths:

  • {{REPO_ROOT}}/{{DOCS_DIR}}/{{filename}}.pdf
  • Example: If {{DOCS_DIR}} is mcp-docs/, files are at {{REPO_ROOT}}/mcp-docs/{{filename}}.pdf

Query Examples:

  • "Query documentation for [specific requirement or specification]"
  • "Search [documentation type] for [technical detail]"

External Documentation

[Only include this section if your module needs to reference external documentation]

CRITICAL - Documentation Access: See mcp-docs/claude-code/MCP_STANDARD_RULES.md for complete MCP workflow

BEFORE doing ANYTHING else when asked about [documentation type] specifications:

  1. Check if MCP is configured: cat ~/.claude.json | grep "local-rag"
  2. If not configured → Run cd mcp-docs/claude-code && ./setup.sh and tell user to restart
  3. If configured → Use mcp__local-rag__query_documents to search documentation
  4. NEVER use Read tool on documentation files - always use MCP Local RAG

Available [documentation type] specifications (in mcp-docs/):

  • [doc-name-1]: [What it contains]
  • [doc-name-2]: [What it contains]
  • [doc-name-3]: [What it contains]

Query examples for this module:

  • "[Specific query example relevant to your domain]"
  • "[Another query example]"
  • "[Third query example]"
  • "[Fourth query example]"

Future additions:

  • [Planned documentation to add]

Purpose

[AUTO-DETECT: Infer from module structure and code]

Package Structure

Main Packages

[AUTO-DETECT: Discover sub-packages and infer purposes from names]

Key Classes

[AUTO-DETECT: Discover using file listing and code scanning]

Processing Flow

[AUTO-DETECT: Infer from code structure, or ASK USER if too complex]

Configuration

[AUTO-DETECT: Discover from config files and code annotations]

Data Models

[AUTO-DETECT: Discover from code patterns]

Common Tasks

Testing

[AUTO-DETECT: Describe test structure if tests exist, otherwise DELETE]

When to Consult Other Module Contexts

[Only include this section if there are actual cross-module dependencies or troubleshooting scenarios]

Read these contexts when:

  • [Parent/Core Module] (../CLAUDE_CONTEXT.md):

    • When: [Specific scenario requiring parent context]
    • Why: [Reason - e.g., "inherits from base class", "shares configuration", etc.]
    • Look for: [Specific information to find]

  • [Related Module 1] (../module1/CLAUDE_CONTEXT.md):

    • When: [Specific scenario requiring this context]
    • Why: [Reason - e.g., "depends on data from", "shares code with", etc.]
    • Look for: [Specific information to find]

  • [Related Module 2] (../module2/CLAUDE_CONTEXT.md):

    • When: [Specific scenario requiring this context]
    • Why: [Reason - e.g., "comparing implementations", "debugging interactions", etc.]
    • Look for: [Specific information to find]

Cross-module code dependencies:

  • [ClassName from other module]: [What it's used for in this module]
  • [Another dependency]: [Usage description]

Common Pitfalls

  1. [Common mistake and how to avoid it]
  2. [Common mistake and how to avoid it]

Performance Considerations

[Performance tips specific to this module]