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

# Core Features

> Overview of Arch MCP capabilities

Arch MCP Server provides three types of capabilities that work together to enable intelligent interaction with the Arch Linux ecosystem.

## 🔍 Resources

URI-based access to Arch ecosystem data - read documentation, package info, and system state.

<Card title="Resources Reference" icon="folder-open" href="/arch-mcp/resources">
  **24 URI schemes** for accessing Arch Wiki, AUR packages, official repos, system data, logs, news, configuration, and mirrors
</Card>

<Frame caption="Direct access to Arch Wiki documentation through URI schemes">
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/nxk/images/examples/dual-boot-setup.png" alt="Example of accessing Arch Wiki resources" style={{ borderRadius: '0.5rem' }} />
</Frame>

**What you can do:**

* Access Arch Wiki pages in Markdown format
* Fetch PKGBUILD files with safety annotations
* Query AUR package metadata
* Look up official repository packages
* List installed packages (Arch only)

## 🛠️ Tools

Executable functions for search, security analysis, and package installation.

<Card title="Tools Reference" icon="wrench" href="/arch-mcp/tools">
  **22 unified tools** organized into 9 categories: discovery, lifecycle, maintenance, organization, security, monitoring, history, mirrors, and configuration
</Card>

<Frame caption="Security analysis tools providing comprehensive package safety checks">
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/nxk/images/examples/security-review.png" alt="Example of security analysis tools in action" style={{ borderRadius: '0.5rem' }} />
</Frame>

**What you can do:**

* Search Arch Wiki and AUR packages
* Analyze PKGBUILD files for security risks
* Evaluate package trustworthiness
* Check for system updates safely
* Install packages with automated security checks

## 📋 Prompts

Guided multi-step workflows that combine resources and tools for complex tasks.

<Card title="Prompts Reference" icon="messages" href="/arch-mcp/prompts">
  **8 intelligent workflows** for troubleshooting, security audits, dependency analysis, system updates, cleanup, and health checks
</Card>

<Frame caption="Intelligent workflows that combine multiple tools for complex tasks">
  <img src="https://mintcdn.com/nxk/pBLV8x_ZKJSFKjz7/images/examples/dependency-analysis.png?fit=max&auto=format&n=pBLV8x_ZKJSFKjz7&q=85&s=719045d191737f23bcc706fdfb95db45" alt="Example of dependency analysis prompt workflow" style={{ borderRadius: '0.5rem' }} width="705" height="785" data-path="images/examples/dependency-analysis.png" />
</Frame>

**What you can do:**

* Diagnose system issues with Wiki-guided solutions
* Audit AUR packages before installation
* Plan installations by analyzing dependencies

## Feature Comparison

Quick reference to understand what each capability type offers:

| Capability    | Count | Access Method     | Use When                       | Example                  |
| ------------- | ----- | ----------------- | ------------------------------ | ------------------------ |
| **Resources** | 23+   | URI schemes       | Need raw data or documentation | `archwiki://Systemd`     |
| **Tools**     | 22    | Function calls    | Need to perform operations     | `search_aur query="vim"` |
| **Prompts**   | 8     | Workflow triggers | Need guided multi-step process | `audit_aur_package`      |

<Info>
  **Best Practice:** Combine all three types for powerful workflows! Resources provide data, Tools perform operations, and Prompts orchestrate complex tasks.
</Info>

***

## How They Work Together

See how Resources, Tools, and Prompts combine to solve real problems.

### Interactive Workflow Example

<Steps>
  <Step title="User asks a security question">
    **User Query:**

    ```
    I want to install neofetch from AUR, but I'm concerned about security
    ```

    <Info>
      The AI assistant automatically determines the best workflow for this request.
    </Info>
  </Step>

  <Step title="Resource: Fetch PKGBUILD">
    **Resource Access:**

    ```
    aur://neofetch/pkgbuild
    ```

    The system uses the PKGBUILD resource to fetch the raw build script for inspection.

    <Tip>
      Resources provide read-only access to data without executing anything.
    </Tip>
  </Step>

  <Step title="Tool: Analyze PKGBUILD Safety">
    **Tool Execution:**

    ```
    audit_package_security action="pkgbuild_analysis" package_name="neofetch"
    ```

    Scans for security threats:

    * ✅ Dangerous commands (`rm -rf /`, `dd`, etc.)
    * ✅ Suspicious downloads (`curl|sh`, `wget|bash`)
    * ✅ Obfuscated code (base64, eval)
    * ✅ Privilege escalation attempts

    <Warning>
      This tool uses pattern matching - always manually review PKGBUILDs too!
    </Warning>
  </Step>

  <Step title="Resource: Get Package Metadata">
    **Resource Access:**

    ```
    aur://neofetch/info
    ```

    Provides community trust indicators:

    * Popularity votes (2,500+)
    * Maintainer information
    * Last update date
    * Package age and history
  </Step>

  <Step title="Tool: Evaluate Trust Score">
    **Tool Execution:**

    ```
    audit_package_security action="metadata_risk" package_name="neofetch"
    ```

    Evaluates:

    * Is the maintainer trustworthy?
    * How popular is this package?
    * Is it actively maintained?
    * Any red flags in metadata?

    <Check>
      Trust score: 85/100 - High community trust
    </Check>
  </Step>

  <Step title="Tool: Secure Installation">
    **Tool Execution:**

    ```
    install_package_secure package="neofetch" aur=true
    ```

    If security checks pass:

    * Presents comprehensive security report
    * Asks for final confirmation
    * Handles installation with AUR helper
    * Logs transaction for audit trail

    <Tip>
      Use `install_package_secure` instead of manual installation for built-in safety!
    </Tip>
  </Step>
</Steps>

**Result:** You get a secure, well-informed AUR package installation with full understanding of what's being installed and why it's safe.

<Note>
  **Automation:** The entire workflow above can be triggered with a single prompt: `audit_aur_package package="neofetch"`
</Note>

***

### Workflow Visualization

<Mermaid
  chart={`
graph TD
A[User Query] -->|Natural Language| B{AI Assistant}
B -->|Fetch Data| C[Resources]
B -->|Perform Actions| D[Tools]
B -->|Complex Task| E[Prompts]

C --> F[archwiki://]
C --> G[aur://pkgbuild]
C --> H[aur://info]

D --> I[audit_package_security]
D --> J[audit_package_security]
D --> K[install_package_secure]

E --> L[audit_aur_package]
E --> M[troubleshoot]
E --> N[analyze_dependencies]

L --> C
L --> D
M --> C
M --> D
N --> C
N --> D

F --> O[Markdown Content]
G --> P[PKGBUILD File]
H --> Q[JSON Metadata]

I --> R[Security Report]
J --> S[Trust Score]
K --> T[Installation Result]

O --> U[AI Response]
P --> U
Q --> U
R --> U
S --> U
T --> U
`}
/>

<Tip>
  **Pro Tip:** You don't need to know all this! Just ask in natural language, and the AI figures out the optimal workflow.
</Tip>

## Capability Statistics

<CardGroup cols={3}>
  <Card title="24 Resources" icon="database">
    URI-based data access for Wiki pages, PKGBUILDs, package info, and system data
  </Card>

  <Card title="22 Tools" icon="wrench">
    Executable functions across 9 categories for all Arch Linux operations
  </Card>

  <Card title="8 Prompts" icon="messages">
    Guided workflows for troubleshooting, auditing, system updates, cleanup, and health checks
  </Card>
</CardGroup>

### Tools by Category

| Category                   | Tool Count | Permission | Common Uses                      |
| -------------------------- | ---------- | ---------- | -------------------------------- |
| 🔍 Discovery & Information | 4          | Read       | Search Wiki/AUR, get news        |
| 📦 Package Lifecycle       | 3          | Mixed      | Install, update, remove packages |
| 🔧 Package Maintenance     | 4          | Mixed      | Verify, mark, clean orphans      |
| 📁 File Organization       | 2          | Read       | Find owners, list files, search  |
| 🔒 Security Analysis       | 1          | Read       | PKGBUILD/metadata scanning       |
| 📊 System Monitoring       | 4          | Read       | Disk space, services, logs       |
| 📜 Transaction History     | 1          | Read       | Audit package operations         |
| 🌐 Mirror Management       | 1          | Read       | Test speed, suggest mirrors      |
| ⚙️ Configuration           | 2          | Read       | Parse pacman/makepkg configs     |

<Info>
  **Platform Support:**

  * **7 tools** work on any platform (use remote APIs)
  * **1 tool** works on systemd-based systems
  * **14 tools** require Arch Linux (use local system)
  * **All resources** work on any platform
</Info>

## Learn More

<CardGroup cols={3}>
  <Card title="Security Features" icon="shield" href="/arch-mcp/secure-installation">
    PKGBUILD analysis and safety mechanisms
  </Card>

  <Card title="Examples" icon="code" href="/arch-mcp/examples">
    Practical usage scenarios
  </Card>

  <Card title="Architecture" icon="diagram" href="/arch-mcp/architecture">
    Design and implementation details
  </Card>
</CardGroup>
