@appium/mcp-documentation 1.0.0

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "@appium/mcp-documentation",
+  "version": "1.0.0",
+  "type": "module",
+  "description": "Appium MCP documentation query tools and indexed documentation assets",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/appium/appium-mcp-documentation.git"
+  },
+  "bugs": {
+    "url": "https://github.com/appium/appium-mcp-documentation/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./tools": {
+      "types": "./dist/tools.d.ts",
+      "import": "./dist/tools.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "rimraf dist tsconfig.tsbuildinfo && tsc -b && npm run copy-assets",
+    "copy-assets": "mkdir -p dist/uploads dist/scripts && cp -f src/uploads/documents.json dist/uploads/documents.json 2>/dev/null || true && cp -f src/uploads/embeddings-*.json dist/uploads/ 2>/dev/null || true && cp -f src/scripts/rag-eval-dataset.json dist/scripts/rag-eval-dataset.json 2>/dev/null || true",
+    "index-docs": "node dist/scripts/simple-index-documentation.js",
+    "query-docs": "node dist/scripts/simple-query-documentation.js",
+    "eval-docs": "node dist/scripts/eval-documentation-rag.js",
+    "generate-cache": "node dist/scripts/generate-embeddings-cache.js",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest",
+    "lint": "eslint src --ext .ts",
+    "format:check": "prettier --check \"src/**/*.{ts,js,json}\"",
+    "format": "prettier --write \"src/**/*.{ts,js,json}\"",
+    "setup-submodules": "./scripts/setup-submodules-sparse.sh",
+    "update-submodules": "./scripts/update-submodules.sh",
+    "zip-assets": "node scripts/zip-assets.mjs zip",
+    "unzip-assets": "node scripts/zip-assets.mjs unzip",
+    "preinstall": "node scripts/zip-assets.mjs unzip"
+  },
+  "files": [
+    "dist",
+    "scripts/zip-assets.mjs",
+    "src/resources/submodules.zip",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md",
+    "README.md"
+  ],
+  "keywords": [
+    "appium",
+    "mcp",
+    "documentation",
+    "rag"
+  ],
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@appium/support": "^7.0.2",
+    "@langchain/classic": "^1.0.10",
+    "@langchain/core": "^1.1.17",
+    "@langchain/textsplitters": "^1.0.1",
+    "@xenova/transformers": "^2.17.2",
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "@appium/eslint-config-appium-ts": "^3.0.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@jest/globals": "^30.2.0",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^25.0.9",
+    "fastmcp": "^4.0.0",
+    "jest": "^30.2.0",
+    "prettier": "^3.5.3",
+    "rimraf": "^6.0.1",
+    "semantic-release": "^25.0.3",
+    "typescript": "^6.0.2"
+  }
+}

package/scripts/zip-assets.mjs

@@ -0,0 +1,75 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import fs from 'node:fs/promises';
+
+import { zip as appiumZip } from '@appium/support';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+// Adjust these paths for your use case
+const ZIP_SOURCE_DIR = path.join(
+  __dirname,
+  '..',
+  'src',
+  'resources',
+  'submodules'
+);
+const ZIP_OUTPUT_PATH = path.join(
+  __dirname,
+  '..',
+  'src',
+  'resources',
+  'submodules.zip'
+);
+const UNZIP_TARGET_DIR = path.join(
+  __dirname,
+  '..',
+  'src',
+  'resources',
+  'submodules'
+);
+
+export async function zipAssets() {
+  const zipBase64 = await appiumZip.toInMemoryZip(ZIP_SOURCE_DIR);
+  const zipBuffer = Buffer.from(zipBase64, 'base64');
+  await fs.writeFile(ZIP_OUTPUT_PATH, zipBuffer);
+  console.log(`Zipped ${ZIP_SOURCE_DIR} -> ${ZIP_OUTPUT_PATH}`);
+}
+
+const fileExists = async (filePath) => {
+  try {
+    await fs.access(filePath);
+    return true;
+  } catch {
+    return false;
+  }
+};
+
+export async function unzipAssets() {
+  if (!(await fileExists(ZIP_OUTPUT_PATH))) {
+    console.log(
+      `Target directory ${ZIP_OUTPUT_PATH} does not exist. Skipping unzip.`
+    );
+    return;
+  }
+  await appiumZip.extractAllTo(ZIP_OUTPUT_PATH, UNZIP_TARGET_DIR);
+  console.log(`Unzipped ${ZIP_OUTPUT_PATH} -> ${UNZIP_TARGET_DIR}`);
+}
+
+if (import.meta.url === `file://${process.argv[1]}`) {
+  const cmd = process.argv[2];
+  if (cmd === 'zip') {
+    zipAssets().catch((e) => {
+      console.error(e);
+      process.exitCode = 1;
+    });
+  } else if (cmd === 'unzip') {
+    unzipAssets().catch((e) => {
+      console.error(e);
+      process.exitCode = 1;
+    });
+  } else {
+    console.log('Usage: node zip-assets.mjs [zip|unzip]');
+  }
+}