@gala-chain/launchpad-mcp-server 4.0.22-beta.1 → 4.0.22-beta.3

package/DOCS_AUDIT_REPORT.md

@@ -0,0 +1,189 @@
+# Documentation Audit Report
+
+**Generated:** 2025-12-09
+**SDK Version:** 4.0.22-beta.1
+**MCP Server Version:** 4.0.22-beta.1
+**MCP Tool Count:** 128
+
+## Executive Summary
+
+| Category | Status | Critical Issues |
+|----------|--------|-----------------|
+| READMEs | CRITICAL | Version 4.0.17-beta.2 (outdated), tool count 105 (should be 128) |
+| Docs | WARNING | Version mismatches in 4 files, outdated method counts |
+| CLAUDE.md | CRITICAL | Tool count 127→128, demo counts outdated (79→92) |
+| Package.json | CRITICAL | MCP description says "105 tools" (should be 128) |
+| Examples | OK | 3 hardcoded imports, no deprecated API usage |
+| explainSdkUsage | CRITICAL | 'locks' topic uses deprecated singular methods, missing burn-tokens topic |
+| JSDoc | EXCELLENT | All methods fully documented |
+| Cleanup | WARNING | Stale files found |
+
+---
+
+## Category Details
+
+### 1. README Files
+
+#### Root README.md
+- **Line 40**: Version `4.0.17-beta.2` → should be `4.0.22-beta.1`
+- **Line 122**: Tool count `105 tools` → should be `128 tools`
+
+#### packages/sdk/README.md
+- Version reference outdated in multiple locations
+
+#### packages/mcp-server/README.md
+- **Description**: Says "105 tools" → should be "128 tools"
+- **Installation example**: Uses outdated version reference
+- **Slash command section**: Inconsistent tool count
+
+### 2. Documentation Files
+
+| File | Issue |
+|------|-------|
+| docs/API-REFERENCE.md | Missing new method documentation |
+| docs/DOCUMENTATION_CHANGELOG.md | Outdated SDK method count (116) |
+| docs/gswap-integration.md | Version mismatch (v4.0.17-beta.2) |
+| docs/LIQUIDITY_DEMOS.md | Version mismatch |
+| docs/LIQUIDITY_PRICING_OPTIONS.md | Version mismatch |
+
+**Good news:** No deprecated `lockToken`/`unlockToken` references found in docs.
+
+### 3. CLAUDE.md
+
+| Line | Current | Should Be |
+|------|---------|-----------|
+| 297 | "127 tools" | "128 tools" |
+| 363 | "79 demos" | "92 demos" |
+| 604 | "82 working examples" | "92 working examples" |
+| 605 | "74 demo: script shortcuts" | "86 demo: script shortcuts" |
+
+### 4. Package.json Files
+
+#### Root package.json
+- Version: `4.0.17-beta.2` → should be `4.0.22-beta.1`
+- Tool count reference: `105 tools` → should be `128 tools`
+
+#### packages/mcp-server/package.json (Line 4)
+- Description: `"105 tools"` → should be `"128 tools"`
+
+#### packages/sdk/package.json
+- **Correct** - Version is `4.0.22-beta.1`
+
+### 5. Examples Audit
+
+**Statistics:**
+- **Total demo files:** 92
+- **npm scripts registered:** 86
+- **Categories:** 11 organized directories
+
+**Issues Found:**
+- 3 files with hardcoded absolute imports in fees demos:
+  - `examples/fees/trade-and-collect-fees.ts`
+  - `examples/fees/demo-multi-wallet-fee-generation.ts`
+  - `examples/fees/demo-fee-generation-and-collection.ts`
+
+**Good news:** No deprecated `lockToken`/`unlockToken` usage found.
+
+### 6. explainSdkUsage Coverage
+
+**CRITICAL ISSUES:**
+
+#### 'locks' Topic (Line 39, 700-824)
+Uses deprecated singular methods throughout:
+- `lockToken()` → should be `lockTokens()`
+- `unlockToken()` → should be `unlockTokens()`
+
+**Affected lines in SDK_EXAMPLES:**
+- Line 704: `lockToken()` method reference
+- Line 705: `unlockToken()` method reference
+- Line 722: `sdk.lockToken({`
+- Line 735: `sdk.lockToken({`
+- Line 746: `sdk.lockToken({`
+- Line 760: `sdk.unlockToken({`
+- Line 769: `sdk.unlockToken({`
+- Line 783: `sdk.lockToken({`
+- Line 794: `sdk.unlockToken({`
+- Line 810: `sdk.lockToken({`
+- Line 821: `sdk.unlockToken({` (comment)
+
+#### Missing Topic
+- **burn-tokens** topic missing entirely - `burnTokens()` method has no documentation
+
+#### Description Mismatch
+- Line 3337: Claims "34 composite workflow topics" but enum has 34 topics
+- Should update to reflect any new topics added
+
+### 7. JSDoc Coverage
+
+**EXCELLENT** - All new methods have comprehensive JSDoc:
+- `lockTokens()` - Full documentation with @example
+- `unlockTokens()` - Full documentation with @example
+- `burnTokens()` - Full documentation with @example
+- All parameters, return types, and batch behavior documented
+
+### 8. Stale/Rogue Files
+
+| File | Status | Action |
+|------|--------|--------|
+| DOCS_AUDIT_REPORT.md | Stale (2025-12-07) | Will be replaced by this report |
+| DOCS_AUDIT_FOLLOWUP.md | Can be archived | Archive or delete |
+| MCP_COVERAGE_REPORT.md | Stale (references "103 tools") | Update or archive |
+| .claude/commands/*.md | Tool counts outdated | Update |
+
+---
+
+## Required Fixes
+
+### High Priority (CRITICAL)
+
+1. **explainSdkUsage.ts 'locks' topic**
+   - Replace all `lockToken` → `lockTokens`
+   - Replace all `unlockToken` → `unlockTokens`
+   - Update method examples to use batch API
+
+2. **Add 'burn-tokens' topic to explainSdkUsage.ts**
+   - Add to TOPIC_METHOD_MAPPING
+   - Add to COMPOSITE_TOPICS
+   - Add to enum in inputSchema
+   - Add SDK_EXAMPLES entry
+
+3. **Update tool counts across all files**
+   - 105 → 128 (multiple files)
+   - 127 → 128 (CLAUDE.md)
+
+4. **Update MCP package.json description**
+   - "105 tools" → "128 tools"
+
+### Medium Priority (WARNING)
+
+5. **Update version numbers**
+   - 4.0.17-beta.2 → 4.0.22-beta.1 in root README
+
+6. **Update demo/script counts in CLAUDE.md**
+   - 79 → 92 demos
+   - 74 → 86 npm scripts
+   - 82 → 92 working examples
+
+### Low Priority
+
+7. **Fix hardcoded imports in fees examples**
+   - Use relative imports instead of absolute paths
+
+8. **Archive stale documentation files**
+   - DOCS_AUDIT_FOLLOWUP.md
+   - MCP_COVERAGE_REPORT.md (if outdated)
+
+---
+
+## Action Plan
+
+1. Fix explainSdkUsage.ts (locks topic + add burn-tokens)
+2. Update tool counts across all documentation
+3. Update version references
+4. Update demo counts in CLAUDE.md
+5. Fix hardcoded imports
+6. Archive stale files
+
+---
+
+*This report was generated by the `/scour-docs all` documentation audit command.*