{"_id":"@bosbase/sdk-docs-mcp","_rev":"2-fb61da1b19bb5e48cae67758a9d1f5ca","name":"@bosbase/sdk-docs-mcp","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@bosbase/sdk-docs-mcp","version":"1.0.0","keywords":["mcp","model-context-protocol","sdk","documentation","bosbase","javascript","dart","api"],"author":"","license":"MIT","_id":"@bosbase/sdk-docs-mcp@1.0.0","maintainers":[{"name":"bosbase","email":"wmydz1@gmail.com"}],"homepage":"https://github.com/yourusername/bosbase-sdk-docs-mcp#readme","bugs":{"url":"https://github.com/yourusername/bosbase-sdk-docs-mcp/issues"},"dist":{"shasum":"f8d6a5a4a2eb6fa676db0d358e6b6d3d14985524","tarball":"https://registry.npmjs.org/@bosbase/sdk-docs-mcp/-/sdk-docs-mcp-1.0.0.tgz","fileCount":37,"integrity":"sha512-Bz225Wwk3Jw34i3Mx7yZGS6q/c+Dw3VP0DZY2eELhRU833mh+kSPl+7xGL7rBI/GesSRFLpaK1WMV2IAJz2Zqw==","signatures":[{"sig":"MEYCIQClgprTgvQ3Pe3uVftNtuS5Dk2pDWEMjicIIt4qiDctjwIhALga/BxwZMSiGaCV3eXpvml5vBq33ImpXiXmKOHnfQ8s","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":466822},"main":"dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=18.0.0"},"gitHead":"0c4321c9cd77d102035b75fcfab2d897bb05721f","scripts":{"dev":"tsx src/index.ts","build":"tsc","start":"node dist/index.js"},"_npmUser":{"name":"bosbase","email":"wmydz1@gmail.com"},"repository":{"url":"git+https://github.com/yourusername/bosbase-sdk-docs-mcp.git","type":"git"},"_npmVersion":"10.9.3","description":"MCP service for BosBase JS and Dart SDK documentation","directories":{},"_nodeVersion":"22.20.0","dependencies":{"@modelcontextprotocol/sdk":"^0.5.0"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.7.0","typescript":"^5.3.0","@types/node":"^20.10.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk-docs-mcp_1.0.0_1762265659991_0.5564906018860134","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@bosbase/sdk-docs-mcp","version":"1.0.1","description":"MCP service for BosBase JS and Dart SDK documentation","type":"module","main":"dist/index.js","scripts":{"build":"tsc","start":"node dist/index.js","dev":"tsx src/index.ts"},"keywords":["mcp","model-context-protocol","sdk","documentation","bosbase","javascript","dart","api"],"author":"","license":"MIT","repository":{"type":"git","url":"git+https://github.com/yourusername/bosbase-sdk-docs-mcp.git"},"engines":{"node":">=18.0.0"},"dependencies":{"@modelcontextprotocol/sdk":"^0.5.0"},"devDependencies":{"@types/node":"^20.10.0","tsx":"^4.7.0","typescript":"^5.3.0"},"_id":"@bosbase/sdk-docs-mcp@1.0.1","gitHead":"5e9a840884ae3c54f1a5afd0306b6e8d64f2664e","types":"./dist/index.d.ts","bugs":{"url":"https://github.com/yourusername/bosbase-sdk-docs-mcp/issues"},"homepage":"https://github.com/yourusername/bosbase-sdk-docs-mcp#readme","_nodeVersion":"22.20.0","_npmVersion":"10.9.3","dist":{"integrity":"sha512-WTY88ltZnOfglRmBnOEQZ/nxU3r76IoV5QIL9u1wD6niPwlJ9lTzeX86TbQMlZb66ymDs1k5s6w4FcMcOmXn7w==","shasum":"cd9fcff7404896ee7307dc8ed1cfa58345c46ab8","tarball":"https://registry.npmjs.org/@bosbase/sdk-docs-mcp/-/sdk-docs-mcp-1.0.1.tgz","fileCount":37,"unpackedSize":466821,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIEhMpQEWNFL1XepJyzmDXoIHcWmGwS7o/4ba134pj6zFAiEA8WqmRoeR8Vca2gGbZtaCOOrHJ1Q2/1+Vxe18YHJS/y4="}]},"_npmUser":{"name":"bosbase","email":"wmydz1@gmail.com"},"directories":{},"maintainers":[{"name":"bosbase","email":"wmydz1@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/sdk-docs-mcp_1.0.1_1762266585344_0.873559710425972"},"_hasShrinkwrap":false}},"time":{"created":"2025-11-04T14:14:19.871Z","modified":"2025-11-04T14:29:45.698Z","1.0.0":"2025-11-04T14:14:20.196Z","1.0.1":"2025-11-04T14:29:45.519Z"},"bugs":{"url":"https://github.com/yourusername/bosbase-sdk-docs-mcp/issues"},"license":"MIT","homepage":"https://github.com/yourusername/bosbase-sdk-docs-mcp#readme","keywords":["mcp","model-context-protocol","sdk","documentation","bosbase","javascript","dart","api"],"repository":{"type":"git","url":"git+https://github.com/yourusername/bosbase-sdk-docs-mcp.git"},"description":"MCP service for BosBase JS and Dart SDK documentation","maintainers":[{"name":"bosbase","email":"wmydz1@gmail.com"}],"readme":"# BosBase SDK Documentation MCP Service\n\nThis MCP (Model Context Protocol) service provides access to BosBase JavaScript and Dart SDK documentation, allowing AI assistants to learn about and reference SDK capabilities.\n\n**Note:** This is a self-contained MCP service. All documentation files are included in the `mcp/docs/` directory.\n\n## Features\n\n- **Resources**: Exposes all SDK documentation files as MCP resources\n- **Search Tool**: Search across both JS and Dart SDK documentation\n- **Get Doc Tool**: Retrieve specific documentation by topic and SDK\n- **List Docs Tool**: List all available documentation resources\n\n## Installation\n\n### From npm\n\n```bash\nnpm install -g @bosbase/sdk-docs-mcp\n```\n\nThen configure your MCP client to point to the installed package:\n\n```json\n{\n  \"mcpServers\": {\n    \"bosbase-sdk-docs\": {\n      \"command\": \"node\",\n      \"args\": [\"/path/to/node_modules/@bosbase/sdk-docs-mcp/dist/index.js\"]\n    }\n  }\n}\n```\n\nOr if installed globally, you can use `npm root -g` to find the global node_modules path:\n\n```json\n{\n  \"mcpServers\": {\n    \"bosbase-sdk-docs\": {\n      \"command\": \"node\",\n      \"args\": [\"$(npm root -g)/@bosbase/sdk-docs-mcp/dist/index.js\"]\n    }\n  }\n}\n```\n\n\n### As an MCP Server\n\nConfigure this as an MCP server in your AI assistant. Example configuration:\n\n```json\n{\n  \"mcpServers\": {\n    \"bosbase-sdk-docs\": {\n      \"command\": \"node\",\n      \"args\": [\"/path/to/mcp/dist/index.js\"]\n    }\n  }\n}\n```\n\nOr using npm script:\n\n```json\n{\n  \"mcpServers\": {\n    \"bosbase-sdk-docs\": {\n      \"command\": \"npm\",\n      \"args\": [\"--prefix\", \"/path/to/mcp\", \"start\"]\n    }\n  }\n}\n```\n\n### Available Resources\n\nAll documentation files are exposed as resources with URIs like:\n- `sdk-doc://js-collections` - JavaScript SDK Collections documentation\n- `sdk-doc://dart-collections` - Dart SDK Collections documentation\n- `sdk-doc://sdk-overview` - Main SDK documentation overview\n\n### Available Tools\n\n#### `search_sdk_docs`\n\nSearch SDK documentation for specific topics, APIs, or code examples.\n\n**Parameters:**\n- `query` (required): Search query string\n- `sdk` (optional): Filter by SDK type (`js`, `dart`, or `both` - default: `both`)\n- `topic` (optional): Filter by topic (collections, authentication, files, etc.)\n\n**Example:**\n```json\n{\n  \"query\": \"authentication password\",\n  \"sdk\": \"js\",\n  \"topic\": \"authentication\"\n}\n```\n\n#### `get_sdk_doc`\n\nRetrieve a specific SDK documentation file.\n\n**Parameters:**\n- `topic` (required): Documentation topic (collections, authentication, files, etc.)\n- `sdk` (optional): SDK type (`js` or `dart`, required unless topic is \"overview\")\n\n**Example:**\n```json\n{\n  \"topic\": \"collections\",\n  \"sdk\": \"js\"\n}\n```\n\n#### `list_sdk_docs`\n\nList all available SDK documentation resources.\n\n**Parameters:**\n- `sdk` (optional): Filter by SDK type (`js`, `dart`, or `both` - default: `both`)\n\n## Documentation Topics\n\nAvailable documentation topics for both JS and Dart SDKs:\n\n- `collections` - Collection and record management\n  - `api-rules` - API rules and filter syntax\n  - `authentication` - Authentication methods (password, OTP, OAuth2, MFA)\n  - `files` - File upload and handling\n  - `file-api` - File API for downloads and thumbnails\n  - `relations` - Relation fields and expand functionality\n  - `api-records` - CRUD operations and record management\n  - `realtime` - Real-time subscriptions and SSE\n  - `collection-api` - Collection management API\n  - `logs-api` - Log viewing and filtering\n  - `crons-api` - Cron job management\n  - `backups-api` - Backup operations\n  - `health-api` - Health status checks\n\n## Development\n\n```bash\n# Install dependencies\nnpm install\n\n# Build TypeScript\nnpm run build\n\n# Run in development mode (with tsx)\nnpm run dev\n\n# Run built version\nnpm start\n```\n\n## Project Structure\n\n```\nmcp/\n├── src/\n│   └── index.ts          # Main MCP server implementation\n├── dist/                 # Compiled JavaScript (generated)\n├── docs/                 # SDK documentation files\n├── package.json\n├── tsconfig.json\n└── README.md\n```\n\n## License\nMIT","readmeFilename":"README.md"}