> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wistx.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Tools & Features

> Explore all available WISTX MCP tools and capabilities

WISTX provides a comprehensive set of MCP tools that give your AI coding assistant access to DevOps infrastructure knowledge, compliance requirements, pricing data, and best practices.

## Unified Tools (Recommended)

<Info>
  WISTX now provides **6 unified tools** that consolidate multiple capabilities into single, easy-to-use interfaces. These are the recommended tools for new integrations.
</Info>

<CardGroup cols={2}>
  <Card title="wistx_search_code" icon="magnifying-glass">
    🎯 **UNIFIED code search tool**. Combines semantic search, regex search, and code examples into one tool.

    **Modes:**

    * `search_mode="semantic"` - Natural language search on your indexed repos
    * `search_mode="regex"` - Pattern matching with 40+ templates
    * `search_mode="examples"` - WISTX curated production-ready code

    **Replaces:** `wistx_search_codebase`, `wistx_regex_search`, `wistx_get_devops_infra_code_examples`
  </Card>

  <Card title="wistx_infrastructure" icon="server">
    🎯 **UNIFIED infrastructure tool**. All infrastructure operations in one place.

    **Actions:** `init_project`, `design_project`, `review_project`, `optimize_project`, `analyze`, `design`, `validate`, `integrate`, `create`, `update`, `upgrade`, `backup`, `restore`, `monitor`, `get_existing`, `discover`

    **Replaces:** `wistx_design_architecture`, `wistx_manage_infrastructure_lifecycle`, `wistx_manage_infrastructure`, `wistx_get_existing_infrastructure`, `wistx_discover_cloud_resources`
  </Card>

  <Card title="wistx_context" icon="folder">
    🎯 **UNIFIED context management**. Filesystem navigation and conversation context.

    **Actions:**

    * `list_files`, `read_file` - Navigate indexed repositories
    * `save`, `search`, `get`, `list_saved` - Manage saved contexts

    **Replaces:** `wistx_list_filesystem`, `wistx_read_file_with_context`, `wistx_save_context_with_analysis`, `wistx_search_contexts_intelligently`
  </Card>

  <Card title="wistx_index" icon="database">
    🎯 **UNIFIED indexing tool**. Index repositories, docs, and manage resources.

    **Actions:**

    * `repository` - Index GitHub repos
    * `content` - Index documentation/files
    * `list`, `status`, `delete` - Manage indexed resources

    **Replaces:** `wistx_index_repository`, `wistx_index_resource`, `wistx_manage_resources`
  </Card>

  <Card title="wistx_research" icon="book">
    🎯 **UNIFIED research tool**. Deep research across knowledge base and web.

    **Sources:**

    * `knowledge_base` - Internal KB with cross-domain insights
    * `web` - General web search
    * `security` - CVEs, advisories
    * `all` - Combined search

    **Replaces:** `wistx_research_knowledge_base`, `wistx_web_search`
  </Card>

  <Card title="wistx_packages" icon="box">
    🎯 **UNIFIED packages tool**. Search and read DevOps resources.

    **Actions:**

    * `search` - Search packages, tools, services, docs
    * `read_file` - Read package source files

    Searches PyPI, npm, Terraform Registry, Helm, and more.

    **Replaces:** `wistx_search_devops_resources`, `wistx_read_package_file`
  </Card>
</CardGroup>

## Standalone Tools

These tools have unique functionality and are not consolidated:

<CardGroup cols={2}>
  <Card title="wistx_get_compliance_requirements" icon="shield-check">
    Get compliance requirements for infrastructure resources (PCI-DSS, HIPAA, CIS, SOC2, NIST, ISO-27001, GDPR, FedRAMP).
  </Card>

  <Card title="wistx_calculate_infrastructure_cost" icon="calculator">
    **Industry-leading FinOps**: Calculate infrastructure costs with advanced optimization including Spot instance recommendations (60-70% savings), Reserved Instance/Savings Plans guidance (31-58% savings), rightsizing suggestions, and real-time code generation guidance. Exceeds tools like Infracost by providing recommendations during code generation, not just at PR level.
  </Card>

  <Card title="wistx_troubleshoot_issue" icon="wrench">
    Troubleshoot infrastructure issues with AI-powered diagnostics and solutions.
  </Card>

  <Card title="wistx_generate_documentation" icon="file-lines">
    Generate documentation for infrastructure code with compliance, security, and cost analysis.
  </Card>
</CardGroup>

***

## Legacy Tools Reference

<Warning>
  The following tools are deprecated and will be removed in a future version. Please use the unified tools above instead.
</Warning>

## Core Tools

### Compliance & Security

<CardGroup cols={2}>
  <Card title="Get Compliance Requirements" icon="shield-check">
    Get detailed compliance requirements for infrastructure resources. Supports PCI-DSS, HIPAA, CIS, SOC2, NIST-800-53, ISO-27001, GDPR, FedRAMP, and more. Returns specific controls, remediation guidance, code examples, and verification procedures.

    **Tool:** `wistx_get_compliance_requirements`

    **Use cases:**

    * Check compliance requirements for AWS/GCP/Azure resources (RDS, S3, EC2, Lambda, EKS, etc.)
    * Get remediation guidance and code snippets
    * Verify compliance procedures
    * Filter by severity (CRITICAL, HIGH, MEDIUM, LOW)
    * Generate compliance reports automatically
  </Card>

  <Card title="Web Search" icon="magnifying-glass">
    General web search tool for DevOps, infrastructure, compliance, FinOps, and SRE information. Provides unified web search with optional security search capabilities (CVEs, advisories). Default search type is general web search, with security search as an option.

    **Tool:** `wistx_web_search`

    **Use cases:**

    * Search for general DevOps and infrastructure information
    * Find security advisories and CVEs (when using security search type)
    * Get real-time web information
    * Filter by resource type and cloud provider
    * Filter by severity for security searches
    * Search across DevOps, infrastructure, compliance, FinOps, and SRE domains
  </Card>

  <Card title="Regex Search" icon="magnifying-glass">
    Search user's indexed codebase using regex patterns. Perfect for security audits, compliance checks, and code analysis. Supports 40+ pre-built templates (secrets, API keys, credentials, compliance violations, Terraform/Kubernetes resources, etc.) or custom regex patterns.

    **Tool:** `wistx_regex_search`

    **Use cases:**

    * Find secrets and API keys using pre-built templates (api\_key, password, aws\_access\_key, github\_token, etc.)
    * Security audits with pattern matching
    * Compliance checks for violations (unencrypted\_storage, public\_access, no\_mfa, etc.)
    * Code analysis (terraform\_resource, kubernetes\_secret, function\_definition, etc.)
    * Custom pattern matching with regex (up to 10,000 characters)
    * Filter by code type, cloud provider, and file types
    * Configure regex options (case-sensitive, multiline, dotall)
    * Include surrounding code context (0-10 lines, configurable)
    * Maximum 1,000 results per search with timeout support
  </Card>
</CardGroup>

### Infrastructure & Cost Management (Advanced FinOps)

<CardGroup cols={2}>
  <Card title="Calculate Infrastructure Cost" icon="calculator">
    **Industry-leading FinOps tool** that exceeds traditional cost calculators. Get monthly/annual costs with advanced optimization recommendations during code generation - before infrastructure is deployed.

    **Tool:** `wistx_calculate_infrastructure_cost`

    **Advanced FinOps Features:**

    * **Spot Instance Recommendations**: 60-70% savings with workload suitability analysis, fallback strategies, and allocation recommendations
    * **Reserved Instance/Savings Plans Guidance**: 31-58% savings with term and payment option analysis
    * **Rightsizing Recommendations**: Instance type suggestions based on workload analysis
    * **Code Generation Guidance**: Real-time recommendations for Terraform/CDK code
    * **Budget Integration**: Check against configured budgets before deployment

    **Use cases:**

    * Calculate costs for AWS/GCP/Azure resources
    * Get Spot instance recommendations with risk analysis
    * Receive RI/Savings Plans guidance for production workloads
    * Get rightsizing suggestions based on workload type
    * Real-time cost optimization during code generation
  </Card>

  <Card title="Get DevOps Infrastructure Code Examples" icon="code-branch">
    Search infrastructure code examples from curated repositories. Supports 32+ code types including Terraform, Kubernetes, Docker, CI/CD tools (GitHub Actions, GitLab CI, Jenkins), monitoring tools (Prometheus, Grafana), and more. Returns production-ready code examples with metadata, compliance analysis, and cost estimates.

    **Tool:** `wistx_get_devops_infra_code_examples`

    **Use cases:**

    * Find production-ready code examples for infrastructure resources
    * Search by code type (terraform, kubernetes, docker, github\_actions, etc.)
    * Filter by cloud provider (AWS, GCP, Azure)
    * Filter by compliance standards (PCI-DSS, HIPAA, SOC2, etc.)
    * Get code examples with quality scores and best practices
    * Find examples that implement specific compliance controls
    * Search across 100K+ curated repositories with 200+ stars
  </Card>

  <Card title="Get Existing Infrastructure" icon="server">
    Get existing infrastructure context for a repository. Returns cost analysis, compliance status, and recommendations based on indexed repository data. Use this when coding agents need to understand existing infrastructure before creating new resources.

    **Tool:** `wistx_get_existing_infrastructure`

    **Use cases:**

    * Understand existing infrastructure before creating new resources
    * Get cost analysis for indexed repositories
    * Check compliance status
    * Get recommendations for improvements
  </Card>
</CardGroup>

### Virtual Filesystem & Context Management (NEW)

<CardGroup cols={2}>
  <Card title="List Filesystem" icon="folder">
    Navigate your indexed repositories with infrastructure-aware filesystem views. Browse directory structures, filter by infrastructure type (Terraform, Kubernetes, Docker), and view files grouped by compliance, costs, or security.

    **Tool:** `wistx_list_filesystem`

    **Use cases:**

    * Navigate repository structure like a filesystem
    * View files grouped by infrastructure type
    * Filter by compliance status
    * Filter by cost ranges
    * Filter by security status
    * Infrastructure-aware directory navigation
  </Card>

  <Card title="Read File with Context" icon="file">
    Read specific files from your indexed repositories with rich infrastructure context. Includes dependencies, compliance controls, cost estimates, and security issues automatically.

    **Tool:** `wistx_read_file_with_context`

    **Use cases:**

    * Read files with full infrastructure context
    * See dependencies (direct, transitive, reverse)
    * View compliance controls automatically
    * Get cost estimates for resources
    * Check security issues
    * Line-range reading for large files
  </Card>

  <Card title="Save Context with Analysis" icon="floppy-disk">
    Save conversation, architecture designs, code reviews, or any infrastructure-related context persistently. Automatically analyzes compliance, costs, and security.

    **Tool:** `wistx_save_context_with_analysis`

    **Use cases:**

    * Save important conversations
    * Persist architecture designs
    * Store code review findings
    * Keep troubleshooting sessions
    * Build organizational knowledge base
    * Automatic compliance/cost/security analysis
  </Card>

  <Card title="Search Contexts Intelligently" icon="magnifying-glass">
    Search your saved contexts with infrastructure-aware filters. Find conversations, designs, or reviews by compliance standards, cost ranges, security scores, or infrastructure types.

    **Tool:** `wistx_search_contexts_intelligently`

    **Use cases:**

    * Find past conversations
    * Search architecture designs
    * Filter by compliance standards
    * Filter by cost ranges
    * Filter by security scores
    * Multi-faceted context search
  </Card>
</CardGroup>

### Infrastructure Management

<CardGroup cols={2}>
  <Card title="Manage Infrastructure" icon="server">
    Manage infrastructure lifecycle for Kubernetes clusters and multi-cloud resources. Handles creation, updates, upgrades, backups, monitoring, and optimization.

    **Tool:** `wistx_manage_infrastructure`

    **Use cases:**

    * Create Kubernetes clusters and multi-cloud resources
    * Update and upgrade infrastructure
    * Backup and restore operations
    * Monitor and optimize resources
    * Enforce compliance standards
  </Card>

  <Card title="Discover Cloud Resources" icon="cloud">
    Discover existing cloud resources from AWS accounts and generate Terraform import context. Uses secure cross-account access (STS AssumeRole with External ID) to discover resources that can be imported into Terraform management.

    **Tool:** `wistx_discover_cloud_resources`

    **Use cases:**

    * Discover existing AWS resources (EC2, RDS, S3, Lambda, etc.)
    * Generate Terraform import context with dependency resolution
    * Get import order and Terraform import commands
    * Filter already-managed resources using Terraform state
    * Enrich with compliance, pricing, and best practices
    * Generate infrastructure diagrams
    * Multi-region resource discovery
    * Filter by resource types and tags
    * Auto-retrieve saved connections (no credentials needed after setup)
  </Card>
</CardGroup>

### Knowledge & Research

<CardGroup cols={2}>
  <Card title="Research Knowledge Base" icon="book">
    Deep research tool for DevOps, infrastructure, compliance, FinOps, and platform engineering knowledge. Searches internal knowledge base and optionally includes real-time web search for comprehensive coverage. Use for comprehensive research queries about best practices, patterns, strategies, guides, and cross-domain insights.

    **Tool:** `wistx_research_knowledge_base`

    **Use cases:**

    * Comprehensive research queries (minimum 10 characters)
    * Best practices and patterns
    * Cross-domain insights
    * Filter by domains (compliance, finops, devops, infrastructure, security, architecture, cloud, automation, platform, sre)
    * Filter by content types (guide, pattern, strategy, checklist, reference, best\_practice)
    * Output formats: structured, markdown (default), executive\_summary
    * Include or exclude cross-domain relationships
  </Card>

  <Card title="Search Codebase" icon="code">
    Search user's indexed codebase including repositories, documentation, and documents. Semantic search with AI analysis. Returns explanations, code snippet analysis, pattern detection, and recommendations.

    **Tool:** `wistx_search_codebase`

    **Use cases:**

    * Search through your indexed repositories
    * Find code examples and patterns
    * Get AI-analyzed results with explanations
    * Filter by repository, resource type, file type, code type, and cloud provider
    * Include source code snippets in results
  </Card>
</CardGroup>

### Indexing & Resource Management

<CardGroup cols={2}>
  <Card title="Index Repository" icon="github">
    Index a GitHub repository for user-specific search. Supports both public and private repositories. For public repositories, no GitHub token is needed. For private repositories, the system automatically uses your connected GitHub OAuth token (set up during signup).

    **Tool:** `wistx_index_repository`

    **Use cases:**

    * Index your GitHub repositories (public or private)
    * Make your codebase searchable
    * Support for private repositories with OAuth
    * Customize include/exclude patterns for DevOps-focused indexing
    * Add custom names, descriptions, and tags
  </Card>

  <Card title="Index Resource" icon="document">
    Index content (documentation website or document file) for user-specific search. Unified tool that handles both website crawling and single file indexing. Automatically detects content type based on URL/file extension or explicit content\_type parameter. Supports documentation websites, PDFs, DOCX, Markdown (md), and TXT files.

    **Tool:** `wistx_index_resource`

    **Use cases:**

    * Index documentation websites (with URL pattern filtering)
    * Index PDFs and DOCX documents
    * Index Markdown and text files
    * Make documentation searchable
    * Customize include/exclude URL patterns for websites
    * Use content\_url for remote files or file\_path for local uploads
  </Card>

  <Card title="List Resources" icon="list">
    List all indexed resources for the user. See what repositories, documentation, or documents have been indexed. Includes AI-analyzed insights about resource collection with patterns, health analysis, and recommendations.

    **Tool:** `wistx_list_resources`

    **Use cases:**

    * View all indexed resources
    * Filter by resource type (repository, documentation, document)
    * Filter by status (pending, indexing, completed, failed)
    * Get AI-analyzed insights and recommendations
  </Card>

  <Card title="Check Resource Status" icon="clock">
    Check indexing status and progress for a specific resource. Monitor indexing progress in real-time.

    **Tool:** `wistx_check_resource_status`

    **Use cases:**

    * Monitor indexing progress
    * Check resource status
    * Get progress updates
    * Track indexing completion
  </Card>

  <Card title="Delete Resource" icon="trash">
    Delete an indexed resource and all associated knowledge articles. Remove indexed content when no longer needed. Supports deletion by repository URL, documentation URL, document URL, or resource ID.

    **Tool:** `wistx_delete_resource`

    **Use cases:**

    * Remove indexed repositories
    * Clean up old resources
    * Manage storage
    * Delete by URL or resource ID
  </Card>
</CardGroup>

### Code Search & Analysis

<CardGroup cols={2}>
  <Card title="Search Packages" icon="box">
    Search DevOps/infrastructure packages across PyPI, NPM, Terraform Registry, Crates.io, Go Modules, Helm Charts, Ansible Galaxy, Maven Central, NuGet, and RubyGems. Supports semantic search (natural language), regex search (pattern matching), and hybrid search. Packages are automatically filtered to DevOps/infrastructure domain.

    **Tool:** `wistx_search_packages`

    **Use cases:**

    * Find packages for compliance and infrastructure patterns
    * Discover infrastructure tools and libraries
    * Search package registries with natural language
    * Use regex patterns for exact matching
    * Filter by registry, domain, and category
  </Card>

  <Card title="Read Package File" icon="file-code">
    Read specific file sections from package source code using SHA256 hash. Get complete context around code snippets found in package searches. No indexing required - fetches packages on-demand from registries.

    **Tool:** `wistx_search_packages_read_file`

    **Use cases:**

    * Get package source code sections
    * Understand package implementation details
    * Review code snippets with context
    * Read up to 200 lines per request
  </Card>
</CardGroup>

### Architecture & Design

<CardGroup cols={2}>
  <Card title="Design Architecture" icon="diagram-project">
    Design and initialize DevOps/infrastructure/SRE/platform engineering projects. Scaffold new projects with compliance and security built-in. Supports initialize, design, review, and optimize actions.

    **Tool:** `wistx_design_architecture`

    **Use cases:**

    * Initialize new projects (Terraform, Kubernetes, DevOps, Platform)
    * Design architectures (microservices, serverless, monolith, event-driven)
    * Review existing architectures
    * Optimize architectures
    * Include compliance standards in design
  </Card>

  <Card title="Manage Integration" icon="plug">
    Analyze, generate, and validate infrastructure component integrations. Handles networking, security, monitoring, and service integrations. Supports analyze, generate, and validate actions.

    **Tool:** `wistx_manage_integration`

    **Use cases:**

    * Analyze existing integrations
    * Generate integration code
    * Validate integrations
    * Handle networking, security, and monitoring integrations
    * Consider compliance standards
  </Card>
</CardGroup>

### Troubleshooting & Documentation

<CardGroup cols={2}>
  <Card title="Troubleshoot Issue" icon="wrench">
    Diagnose and fix infrastructure/code issues. Analyzes errors, logs, and code to identify root causes, provides fix recommendations, and prevention strategies. Supports Terraform, Kubernetes, Docker, CloudFormation, and Ansible.

    **Tool:** `wistx_troubleshoot_issue`

    **Use cases:**

    * Diagnose errors and issues
    * Fix infrastructure problems
    * Get troubleshooting guidance
    * Analyze error messages and logs
    * Get prevention strategies
  </Card>

  <Card title="Generate Documentation" icon="file-lines">
    Generate comprehensive documentation and reports. Creates architecture diagrams, runbooks, compliance reports, security reports, cost reports, API documentation, and deployment guides. Supports Markdown, PDF, HTML, and JSON formats.

    **Tool:** `wistx_generate_documentation`

    **Use cases:**

    * Generate architecture diagrams
    * Create runbooks
    * Generate compliance reports
    * Create security and cost reports
    * Generate API documentation and deployment guides
  </Card>
</CardGroup>

## Tool Categories

### By Function

<Tabs>
  <Tab title="Compliance & Security">
    * `wistx_get_compliance_requirements` - Get compliance requirements with remediation guidance
    * `wistx_regex_search` - Security audits and pattern matching with pre-built templates
  </Tab>

  <Tab title="Web Search">
    * `wistx_web_search` - General web search for DevOps/infrastructure/compliance/FinOps/SRE (with optional security search for CVEs/advisories)
  </Tab>

  <Tab title="Cost & FinOps">
    * `wistx_calculate_infrastructure_cost` - **Advanced FinOps**: Calculate costs with Spot recommendations (60-70% savings), RI/SP guidance (31-58% savings), rightsizing, and code generation guidance
    * `wistx_get_existing_infrastructure` - Infrastructure cost analysis and context
    * `wistx_manage_infrastructure` - Infrastructure lifecycle management
    * `wistx_discover_cloud_resources` - Discover cloud resources and generate Terraform import context
  </Tab>

  <Tab title="Knowledge & Research">
    * `wistx_research_knowledge_base` - Deep research with web search integration
    * `wistx_search_codebase` - Semantic codebase search with AI analysis
    * `wistx_search_packages` - Package search across multiple registries
  </Tab>

  <Tab title="Indexing">
    * `wistx_index_repository` - Index GitHub repositories (public/private)
    * `wistx_index_resource` - Index documentation websites and files
    * `wistx_list_resources` - List indexed resources with AI insights
    * `wistx_check_resource_status` - Check indexing status
    * `wistx_delete_resource` - Delete indexed resources
  </Tab>

  <Tab title="Architecture">
    * `wistx_design_architecture` - Design and initialize projects
    * `wistx_manage_integration` - Manage component integrations
    * `wistx_manage_infrastructure` - Manage infrastructure lifecycle
    * `wistx_discover_cloud_resources` - Discover existing cloud resources for Terraform migration
  </Tab>

  <Tab title="Documentation & Troubleshooting">
    * `wistx_generate_documentation` - Generate docs and reports
    * `wistx_troubleshoot_issue` - Diagnose and fix issues
  </Tab>

  <Tab title="Package Management">
    * `wistx_search_packages` - Search packages across registries
    * `wistx_search_packages_read_file` - Read package source code
  </Tab>
</Tabs>

## Getting Started

Ready to use these tools? Here's how:

<Steps>
  <Step title="Install WISTX MCP">
    Follow our [Installation Guide](/integrations/wistx-mcp) to set up WISTX for your coding agent.
  </Step>

  <Step title="Get Your API Key">
    Sign up at [wistx.ai/api-key](https://wistx.ai/api-key) to get your API key. You'll need this for authentication.
  </Step>

  <Step title="Start Using Tools">
    Ask your AI assistant questions like:

    * "What compliance requirements do I need for a PCI-DSS compliant RDS instance?"
    * "Calculate the cost for an EKS cluster with 3 m5.large nodes"
    * "Index my GitHub repository for search"
    * "Search my codebase for Terraform resources"
  </Step>
</Steps>

## Learn More

* [Installation Guide](/integrations/wistx-mcp) - Set up WISTX MCP
* [API Reference](/api-reference/introduction) - REST API documentation
* [Examples](/guides/examples) - Real-world use cases
* [Troubleshooting](/guides/troubleshooting) - Common issues and solutions


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.