{"_id":"@contiva/sapis-docs-mcp","_rev":"6-eb9c36bb47261e41cc0f06db23627997","name":"@contiva/sapis-docs-mcp","dist-tags":{"latest":"1.1.0"},"versions":{"1.0.0":{"name":"@contiva/sapis-docs-mcp","version":"1.0.0","keywords":["mcp","sap","integration-suite","documentation","search","ai","claude"],"author":{"name":"Robert Fels"},"license":"Apache-2.0","_id":"@contiva/sapis-docs-mcp@1.0.0","maintainers":[{"name":"robertfels","email":"robert.fels@contiva.com"}],"homepage":"https://github.com/robertfels/sapis-docs-mcp#readme","bugs":{"url":"https://github.com/robertfels/sapis-docs-mcp/issues"},"bin":{"sapis-docs-mcp":"build/index.js"},"dist":{"shasum":"ac948daf6d1914a38e809ddd66e2b77374dafb2f","tarball":"https://registry.npmjs.org/@contiva/sapis-docs-mcp/-/sapis-docs-mcp-1.0.0.tgz","fileCount":91,"integrity":"sha512-YJxyS9bSQcL7dT0iL1lvbSAj6dy7nBnLg4JAMzXUP/SEdMfA45e1sSYG+Pn7cmoYD1nnRryicn95eI+8lYExzQ==","signatures":[{"sig":"MEYCIQCRU25svnq5vl9UjttWnbYygrgnqSphb6cfuQvwx7xo8AIhAPtLTZlAkntihISxtzz0EQjlZb36GMRqyNyvJVy1Io+L","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":232990},"main":"./build/index.js","type":"module","types":"./build/index.d.ts","engines":{"node":">=18.0.0"},"gitHead":"03c31af9b1f1d863f09f3440c7b7c08ed2799f1b","scripts":{"dev":"tsc --watch","build":"tsc","start":"node ./build/index.js","prepare":"npm run build","prepublishOnly":"npm run build"},"_npmUser":{"name":"robertfels","email":"robert.fels@contiva.com"},"repository":{"url":"git+https://github.com/robertfels/sapis-docs-mcp.git","type":"git"},"_npmVersion":"11.6.2","description":"MCP server for SAP Integration Suite documentation - enables AI assistants to search and navigate SAP Integration Suite docs","directories":{},"_nodeVersion":"24.4.1","dependencies":{"remark":"^15.0.1","remark-gfm":"^4.0.0","gray-matter":"^4.0.3","strip-markdown":"^6.0.0","@xenova/transformers":"^2.17.2","@modelcontextprotocol/sdk":"^1.0.4"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.7.2","@types/node":"^22.10.2"},"optionalDependencies":{"openai":"^4.77.0","voyageai":"^0.0.6"},"_npmOperationalInternal":{"tmp":"tmp/sapis-docs-mcp_1.0.0_1766387409503_0.2970204766796163","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@contiva/sapis-docs-mcp","version":"1.0.1","keywords":["mcp","sap","integration-suite","documentation","search","ai","claude"],"author":{"name":"Robert Fels"},"license":"Apache-2.0","_id":"@contiva/sapis-docs-mcp@1.0.1","maintainers":[{"name":"robertfels","email":"robert.fels@contiva.com"}],"homepage":"https://github.com/robertfels/sapis-docs-mcp#readme","bugs":{"url":"https://github.com/robertfels/sapis-docs-mcp/issues"},"bin":{"sapis-docs-mcp":"build/index.js"},"dist":{"shasum":"087e2d012e13225259743ed8b0e3521ce5f15783","tarball":"https://registry.npmjs.org/@contiva/sapis-docs-mcp/-/sapis-docs-mcp-1.0.1.tgz","fileCount":91,"integrity":"sha512-LXmrcdUIEfF3s0SW5G8PCY7BX5jO3xpxIO1ZBSot+m4sqYZ5exp0cBwHaBBgWhX/GE+uwHQxrpuVPYS/PQ4sdg==","signatures":[{"sig":"MEYCIQCGcoJMQaHt1fk8OfYzKf5GjfFMX8sUyOQ5liK6a1qHOAIhAJeHfSTptY98AGvQ5cRrWDNZ1CjPWPOGqffbq/X+vPpr","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":237074},"main":"./build/index.js","type":"module","types":"./build/index.d.ts","engines":{"node":">=18.0.0"},"gitHead":"03c31af9b1f1d863f09f3440c7b7c08ed2799f1b","scripts":{"dev":"tsc --watch","build":"tsc","start":"node ./build/index.js","prepare":"npm run build","prepublishOnly":"npm run build"},"_npmUser":{"name":"robertfels","email":"robert.fels@contiva.com"},"repository":{"url":"git+https://github.com/robertfels/sapis-docs-mcp.git","type":"git"},"_npmVersion":"11.6.2","description":"MCP server for SAP Integration Suite documentation - enables AI assistants to search and navigate SAP Integration Suite docs","directories":{},"_nodeVersion":"24.4.1","dependencies":{"remark":"^15.0.1","remark-gfm":"^4.0.0","gray-matter":"^4.0.3","strip-markdown":"^6.0.0","@xenova/transformers":"^2.17.2","@modelcontextprotocol/sdk":"^1.0.4"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.7.2","@types/node":"^22.10.2"},"optionalDependencies":{"openai":"^4.77.0","voyageai":"^0.0.6"},"_npmOperationalInternal":{"tmp":"tmp/sapis-docs-mcp_1.0.1_1766387835589_0.8811101725384862","host":"s3://npm-registry-packages-npm-production"}},"1.1.0":{"name":"@contiva/sapis-docs-mcp","version":"1.1.0","keywords":["mcp","sap","integration-suite","documentation","search","ai","claude"],"author":{"name":"Robert Fels"},"license":"Apache-2.0","_id":"@contiva/sapis-docs-mcp@1.1.0","maintainers":[{"name":"robertfels","email":"robert.fels@contiva.com"}],"homepage":"https://github.com/robertfels/sapis-docs-mcp#readme","bugs":{"url":"https://github.com/robertfels/sapis-docs-mcp/issues"},"bin":{"sapis-docs-mcp":"build/index.js"},"dist":{"shasum":"3e951eebfddf7cc85b14342d3d18ddfc74cae881","tarball":"https://registry.npmjs.org/@contiva/sapis-docs-mcp/-/sapis-docs-mcp-1.1.0.tgz","fileCount":103,"integrity":"sha512-QCqad2sWmIbmBfDylL0/KQi2CJb234wCVhhXi30bzlDIuQ/xsgTSLiQAl7SJy56UDpTkRVcpF7gRBb9ZfwMIFA==","signatures":[{"sig":"MEUCIQCAxdaKU4qFhlF6kJYWnDIVXaO+VQMj+knXNY6926vsYgIgLL3br1FuqQwE2+6meDUfcl/XBko9ZU+bK6lfK6upRNc=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":291895},"main":"./build/index.js","type":"module","types":"./build/index.d.ts","engines":{"node":">=18.0.0"},"gitHead":"03c31af9b1f1d863f09f3440c7b7c08ed2799f1b","scripts":{"dev":"tsc --watch","build":"tsc","start":"node ./build/index.js","prepare":"npm run build","prepublishOnly":"npm run build"},"_npmUser":{"name":"robertfels","email":"robert.fels@contiva.com"},"repository":{"url":"git+https://github.com/robertfels/sapis-docs-mcp.git","type":"git"},"_npmVersion":"11.6.2","description":"MCP server for SAP Integration Suite documentation - enables AI assistants to search and navigate SAP Integration Suite docs","directories":{},"_nodeVersion":"24.4.1","dependencies":{"remark":"^15.0.1","remark-gfm":"^4.0.0","gray-matter":"^4.0.3","strip-markdown":"^6.0.0","@xenova/transformers":"^2.17.2","@modelcontextprotocol/sdk":"^1.0.4"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.7.2","@types/node":"^22.10.2"},"optionalDependencies":{"openai":"^4.77.0","voyageai":"^0.0.6"},"_npmOperationalInternal":{"tmp":"tmp/sapis-docs-mcp_1.1.0_1766394435053_0.6548514956551881","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2025-12-22T07:10:09.386Z","modified":"2026-02-11T15:39:10.160Z","1.0.0":"2025-12-22T07:10:09.632Z","1.0.1":"2025-12-22T07:17:15.726Z","1.1.0":"2025-12-22T09:07:15.202Z"},"bugs":{"url":"https://github.com/robertfels/sapis-docs-mcp/issues"},"author":{"name":"Robert Fels"},"license":"Apache-2.0","homepage":"https://github.com/robertfels/sapis-docs-mcp#readme","keywords":["mcp","sap","integration-suite","documentation","search","ai","claude"],"repository":{"url":"git+https://github.com/robertfels/sapis-docs-mcp.git","type":"git"},"description":"MCP server for SAP Integration Suite documentation - enables AI assistants to search and navigate SAP Integration Suite docs","maintainers":[{"email":"amir.abassi@contiva.com","name":"amirnpmjs"},{"email":"benedikt.koch@contiva.com","name":"bkcon"},{"email":"robert.fels@contiva.com","name":"robertfels"}],"readme":"# SAP Integration Suite Documentation MCP Server\n\n> **Bring the entire SAP Integration Suite documentation directly into Claude Desktop** - search, explore, and get instant answers without leaving your AI assistant.\n\n[![npm version](https://img.shields.io/npm/v/@contiva/sapis-docs-mcp)](https://www.npmjs.com/package/@contiva/sapis-docs-mcp)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)\n\n## What is this?\n\nThis MCP (Model Context Protocol) server gives Claude Desktop instant access to **3,500+ SAP Integration Suite documentation pages**, including:\n\n- 📘 **SAP Integration Suite** - Complete platform documentation\n- 🔌 **Cloud Integration** - Integration flows, adapters, security\n- 🚀 **API Management** - API proxies, policies, analytics\n\n**No more switching between browser tabs.** Ask Claude about SAP Integration Suite directly in your conversation.\n\n---\n\n## Quick Start (2 minutes)\n\n### Step 1: Install via Claude Desktop Config\n\nAdd this to your Claude Desktop configuration:\n\n**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`\n**Windows**: `%APPDATA%\\Claude\\claude_desktop_config.json`\n\n```json\n{\n  \"mcpServers\": {\n    \"sapis-docs\": {\n      \"command\": \"npx\",\n      \"args\": [\"@contiva/sapis-docs-mcp\"]\n    }\n  }\n}\n```\n\n### Step 2: Restart Claude Desktop\n\nThat's it! On first launch, the documentation (~50MB) downloads automatically in 1-2 minutes.\n\n### Step 3: Start asking questions\n\nTry these in Claude:\n\n> \"Search for OAuth 2.0 authentication in API Management\"\n\n> \"Show me how to configure CSRF protection in Cloud Integration\"\n\n> \"What are the best practices for error handling in integration flows?\"\n\n---\n\n## Why Use This?\n\n### ✅ **Instant, Context-Aware Answers**\nInstead of searching through help.sap.com manually, Claude can:\n- Search across all documentation instantly\n- Understand your question contextually\n- Combine information from multiple articles\n- Give you step-by-step guidance based on official docs\n\n### ✅ **Three Powerful Search Methods**\n- **Full-text search** - Find anything in 3,500+ pages\n- **Title-based search** - Fast fuzzy matching for quick lookups\n- **Semantic search** - AI understands what you mean, not just keywords\n\n### ✅ **Works Offline**\nAll documentation and AI embeddings run locally. No API keys needed, no data leaves your machine.\n\n---\n\n## Real-World Examples\n\n### Example 1: Learning a New Feature\n\n**You:**\n> \"I need to set up OAuth 2.0 authentication for my API proxy. Show me the steps.\"\n\n**Claude (with MCP):**\n> I'll search the API Management documentation for OAuth 2.0 setup...\n>\n> Based on the official documentation, here are the steps to configure OAuth 2.0:\n>\n> 1. Create an OAuth 2.0 Provider in API Management\n> 2. Configure the Token Endpoint...\n> [Complete step-by-step guide with exact configuration]\n\n---\n\n### Example 2: Troubleshooting\n\n**You:**\n> \"My integration flow is failing with a CSRF token error. How do I fix this?\"\n\n**Claude (with MCP):**\n> Let me search for CSRF protection documentation in Cloud Integration...\n>\n> The error occurs because Cloud Integration requires CSRF tokens for state-changing operations. Here's how to configure it:\n>\n> [Specific troubleshooting steps from the docs]\n\n---\n\n### Example 3: Architecture Decisions\n\n**You:**\n> \"What's the difference between Basic Authentication and OAuth in SAP Cloud Integration?\"\n\n**Claude (with MCP):**\n> I'll compare both authentication methods from the documentation...\n>\n> **Basic Authentication:**\n> - Use case: [from docs]\n> - Security considerations: [from docs]\n>\n> **OAuth 2.0:**\n> - Use case: [from docs]\n> - Security considerations: [from docs]\n>\n> **Recommendation:** [Based on official SAP guidance]\n\n---\n\n## Features in Detail\n\n### 🎯 AI-Optimized Features (NEW)\n\nThis MCP server includes several features specifically designed to improve AI assistant interaction:\n\n- **7 Built-in Prompts** - Pre-configured workflows for common tasks (troubleshooting, learning adapters, comparing features, etc.)\n- **22 Quick Resources** - Direct access to frequently needed documentation without search\n- **Enhanced Tool Descriptions** - Detailed guidance on when and how to use each tool effectively\n- **Structured Workflows** - Best practice patterns for comprehensive documentation exploration\n\nSee [MCP_IMPROVEMENTS.md](MCP_IMPROVEMENTS.md) for detailed information.\n\n### 🔍 Smart Search Capabilities\n\n```\nClaude can now:\n├─ Search by keywords (full-text)\n├─ Search by topic titles (fuzzy matching)\n├─ Search by meaning (semantic AI search)\n└─ Combine all three for best results\n```\n\n### 📚 Complete Documentation Coverage\n\n- **1,980 files** - Integration Suite main docs\n- **1,175 files** - Cloud Integration specifics\n- **312 files** - API Management guides\n- Automatically updated from [SAP's official repository](https://github.com/SAP-docs/btp-integration-suite)\n\n### ⚡ Performance\n\n- **Startup**: < 1 second\n- **Search**: 100-200ms for full-text, 500ms for semantic\n- **Memory**: ~50-65MB total\n- **First-time setup**: 1-2 minutes (one-time documentation download)\n\n### 🔒 Privacy-First\n\n- **100% local** - All AI embeddings run on your machine\n- **No API keys** - No external services required\n- **No data sharing** - Your queries stay private\n\n---\n\n## Available Commands\n\nOnce installed, Claude can use these tools automatically:\n\n### 🔍 search_documentation\nSearch across all documentation with combined search methods.\n\n**Example questions:**\n- \"Search for SAML authentication\"\n- \"Find documentation about message mapping\"\n- \"Show me API proxy configuration examples\"\n\n**Search Strategies:**\n- `all` (default): Combines fulltext, title, and semantic search\n- `semantic`: Best for conceptual queries (\"how to secure APIs\")\n- `fulltext`: Best for specific terms or error codes\n- `title`: Best for finding articles by name\n\n---\n\n### 📖 read_article\nRead complete documentation articles.\n\n**Example questions:**\n- \"Read the full article about OAuth configuration\"\n- \"Show me the complete guide for CSRF protection\"\n\n**Features:**\n- Accepts file path or LOIO ID\n- Automatically resolves links\n- Includes metadata and related articles\n\n---\n\n### 📑 list_topics\nBrowse documentation structure hierarchically.\n\n**Example questions:**\n- \"List all Cloud Integration topics\"\n- \"Show me the table of contents for API Management\"\n\n**Areas:**\n- `ISuite`: Main Integration Suite documentation\n- `apim`: API Management guides\n\n---\n\n### 🔗 get_related_articles\nFind related documentation automatically.\n\n**Example questions:**\n- \"What else should I read about authentication?\"\n- \"Find related articles to this integration flow guide\"\n\n**Methods:**\n- `links`: Explicit references (fast)\n- `semantic`: Similar content (comprehensive)\n- `both` (default): Combined approach\n\n---\n\n### 💡 Built-in Prompts (NEW)\n\nAI assistants can use pre-configured workflows:\n\n- `sapis_get_started` - Introduction to SAP Integration Suite\n- `sapis_troubleshoot` - Guided troubleshooting with context\n- `sapis_adapter_guide` - Learn about specific adapters\n- `sapis_api_policy` - API Management policy configuration\n- `sapis_best_practices` - Best practices for any topic\n- `sapis_compare` - Compare features or approaches\n- `sapis_explore_topic` - Deep dive into topics\n\n---\n\n### 📚 Quick Resources (NEW)\n\nDirect access to 22 frequently needed articles:\n\n**Categories:**\n- Getting Started (3)\n- Security (OAuth, SAML, CSRF, Basic Auth)\n- Adapters (SOAP, REST, OData, SFTP, Mail)\n- Development (Mapping, Scripting, Error Handling)\n- Operations (Monitoring, Logging, Analytics)\n- Best Practices (Security, Performance, Design)\n\n**Usage:** `readResource(\"sapis://docs/security/oauth\")`\n\n---\n\n## Advanced Configuration\n\n### Custom Documentation Path\n\nIf you cloned the SAP docs repository locally:\n\n```json\n{\n  \"mcpServers\": {\n    \"sapis-docs\": {\n      \"command\": \"npx\",\n      \"args\": [\"@contiva/sapis-docs-mcp\"],\n      \"env\": {\n        \"MCP_DOCS_PATH\": \"/path/to/btp-integration-suite/docs\"\n      }\n    }\n  }\n}\n```\n\n### Cloud Embeddings (Optional)\n\nFor faster initial indexing, use cloud-based embeddings:\n\n```json\n{\n  \"mcpServers\": {\n    \"sapis-docs\": {\n      \"command\": \"npx\",\n      \"args\": [\"@contiva/sapis-docs-mcp\"],\n      \"env\": {\n        \"EMBEDDING_PROVIDER\": \"voyage\",\n        \"VOYAGE_API_KEY\": \"your-api-key\"\n      }\n    }\n  }\n}\n```\n\n**Note:** Local embeddings (default) are free and work offline. Cloud embeddings reduce first-time indexing from 10-15 minutes to 2-3 minutes but require an API key.\n\n---\n\n## Troubleshooting\n\n### \"Documentation not found\" error\n\nThe first run downloads docs automatically. If it fails:\n\n```bash\n# Manual installation\ngit clone https://github.com/SAP-docs/btp-integration-suite.git\nexport MCP_DOCS_PATH=/path/to/btp-integration-suite/docs\n```\n\nThen restart Claude Desktop.\n\n### MCP server not showing up\n\n1. Check your config file path is correct\n2. Ensure JSON syntax is valid (use a JSON validator)\n3. Restart Claude Desktop completely\n4. Check Claude Desktop logs for errors\n\n### Slow semantic search\n\nFirst-time semantic search builds an AI index (10-15 minutes with local embeddings). This is one-time only - subsequent searches are instant.\n\n---\n\n## Development\n\n### Local Development Setup\n\n```bash\n# Clone the MCP server\ngit clone https://github.com/robertfels/sapis-docs-mcp.git\ncd sapis-docs-mcp\n\n# Clone SAP docs (or it downloads automatically)\ngit clone https://github.com/SAP-docs/btp-integration-suite.git\n\n# Install and build\nnpm install\nnpm run build\n\n# Test locally\nnpm start\n```\n\n### Publishing Updates\n\n```bash\nnpm version patch\nnpm publish --otp=<your-2fa-code>\n```\n\n---\n\n## How It Works\n\n```\n┌─────────────────┐\n│  Claude Desktop │\n│                 │\n│  \"Search for    │\n│   OAuth in      │\n│   API Mgmt\"     │\n└────────┬────────┘\n         │\n         │ MCP Protocol\n         ▼\n┌─────────────────────────────────┐\n│  @contiva/sapis-docs-mcp        │\n│                                 │\n│  ┌───────────┐  ┌────────────┐ │\n│  │ Full-text │  │   Title    │ │\n│  │  Search   │  │   Search   │ │\n│  └───────────┘  └────────────┘ │\n│                                 │\n│  ┌───────────────────────────┐ │\n│  │   Semantic AI Search      │ │\n│  │   (Local Embeddings)      │ │\n│  └───────────────────────────┘ │\n│                                 │\n│  ┌───────────────────────────┐ │\n│  │  3,500+ Markdown Files    │ │\n│  │  (Downloaded from SAP)    │ │\n│  └───────────────────────────┘ │\n└─────────────────────────────────┘\n```\n\n---\n\n## Related Projects\n\n- [Model Context Protocol](https://modelcontextprotocol.io/) - Open protocol for AI-tool integration\n- [SAP Integration Suite Docs](https://github.com/SAP-docs/btp-integration-suite) - Official SAP documentation repository\n- [Claude Desktop](https://claude.ai/download) - AI assistant with MCP support\n\n---\n\n## Contributing to SAP Documentation\n\nFound an error in the SAP documentation? You can contribute!\n\nThis MCP server uses the official [SAP Integration Suite documentation repository](https://github.com/SAP-docs/btp-integration-suite). All contributions to the documentation should be made there.\n\n### How to Contribute\n\n1. Open the relevant guide on [SAP Help Portal](https://help.sap.com/docs/SAP_INTEGRATION_SUITE)\n2. Choose **Feedback** > **Edit page** to suggest changes\n3. Or choose **Feedback** > **Create issue** to report problems\n\nSee [SAP's Contribution Guidelines](https://help.sap.com/products/open-documentation-initiative/contribution-guidelines/readme.html) for more details.\n\n### Covered Documentation Areas\n\n| Guide | Description |\n|:---|:---|\n| [SAP Integration Suite](https://help.sap.com/docs/SAP_INTEGRATION_SUITE/51ab953548be4459bfe8539ecaeee98d/5cc6987511104c418b7cb4c25f3d9cb0.html?version=CLOUD) | Platform overview and general capabilities |\n| [SAP API Management](https://help.sap.com/docs/sap-api-management/sap-api-management/sap-api-management-in-cloud-foundry-environment?version=Cloud) | API proxies, policies, and analytics |\n| [SAP Cloud Integration](https://help.sap.com/docs/cloud-integration/sap-cloud-integration/sap-cloud-integration) | Integration flows, adapters, and security |\n\n---\n\n## License\n\nThis MCP server is licensed under [Apache-2.0](LICENSE).\n\nThe SAP documentation content is subject to SAP's licensing terms. See the [SAP documentation repository](https://github.com/SAP-docs/btp-integration-suite) for details.\n\n---\n\n## Support\n\n- **Issues**: [GitHub Issues](https://github.com/robertfels/sapis-docs-mcp/issues)\n- **NPM Package**: [@contiva/sapis-docs-mcp](https://www.npmjs.com/package/@contiva/sapis-docs-mcp)\n- **SAP Documentation**: [help.sap.com](https://help.sap.com/docs/SAP_INTEGRATION_SUITE)\n\n---\n\n**Made with ❤️ for the SAP Integration Suite community**\n\n[![REUSE status](https://api.reuse.software/badge/github.com/SAP-docs/btp-integration-suite)](https://api.reuse.software/info/github.com/SAP-docs/btp-integration-suite)\n","readmeFilename":"README.md"}