CastPlan MCP

Instructions

Implementation Reference

• src/services/DocumentationService.ts:629-664 (handler)

  Core implementation of the docs_validate tool: validates presence of required docs directories (docs/, MASTER_DOCS/), specific master MD files, and CLAUDE.md.

  async validateDocumentationStructure(): Promise<{ valid: boolean; issues: string[] }> {
    const issues: string[] = [];
    
    // Check for required directories
    const requiredDirs = [this.docsRoot, this.masterDocs];
    for (const dir of requiredDirs) {
      if (!this.fs.existsSync(dir)) {
        issues.push(`Missing required directory: ${this.path.relative(this.projectRoot, dir)}`);
      }
    }
  
    // Check for master documentation files
    const requiredMasterDocs = [
      'README.md',
      '01-ARCHITECTURE-OVERVIEW.md',
      '03-QUICK-START-GUIDE.md',
      '04-API-REFERENCE.md'
    ];
  
    for (const doc of requiredMasterDocs) {
      const docPath = this.path.join(this.masterDocs, doc);
      if (!this.fs.existsSync(docPath)) {
        issues.push(`Missing master documentation: ${doc}`);
      }
    }
  
    // Check CLAUDE.md
    if (!this.fs.existsSync(this.claudeMd)) {
      issues.push('Missing CLAUDE.md in project root');
    }
  
    return {
      valid: issues.length === 0,
      issues
    };
  }

• src/tools/documentation/index.ts:81-89 (schema)

  MCP tool schema definition for docs_validate, no input parameters required.

  {
    name: 'docs_validate',
    description: 'Validate documentation structure and completeness',
    inputSchema: {
      type: 'object',
      properties: {},
      required: []
    }
  }

• src/tools/documentation/index.ts:117-119 (registration)

  Tool registration: registers the docs_validate handler as a thin wrapper around DocumentationService.validateDocumentationStructure().

  tools.set('docs_validate', async () => {
    return await documentationService.validateDocumentationStructure();
  });