Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Capabilities
Features and capabilities supported by this server
| Capability | Details |
|---|---|
| tools | {
"listChanged": false
} |
| prompts | {
"listChanged": false
} |
| resources | {
"subscribe": false,
"listChanged": false
} |
| experimental | {} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| search_documentation | Search the UAB Research Computing documentation for relevant content.
This tool searches through the documentation repository to find pages
that match the search query. Useful for finding information about:
- How to use Cheaha HPC cluster
- Research computing policies and procedures
- Getting support and office hours
- Software and tools available
- Storage and data management
Args:
query: The search term or phrase to look for in the documentation
max_results: Maximum number of results to return (default: 5, max: 10)
Returns:
Formatted search results with titles, URLs, and excerpts |
| get_documentation_page | Retrieve the full content of a specific documentation page.
This tool fetches the complete markdown content of a documentation page from the
UAB Research Computing GitHub repository. Use this after finding a relevant
page with the search tool.
Args:
page_path: The path to the documentation page (e.g., "docs/cheaha/slurm/slurm_tutorial.md" or "cheaha/slurm/slurm_tutorial")
Can be a relative path from the repository root or a GitHub URL
Returns:
The full markdown content of the documentation page |
| get_support_info | Get information about how to get support from UAB Research Computing.
This tool provides contact information, office hours, and support channels
for UAB Research Computing services. No parameters required.
Returns:
Comprehensive support information including office hours, contact methods,
and links to support resources |
| list_documentation_sections | List the main sections and categories available in the UAB Research Computing documentation.
This tool provides an overview of the documentation structure to help users
understand what information is available. No parameters required.
Returns:
A structured list of main documentation sections and their purposes |
| get_cheaha_quick_start | Get quick start information for accessing and using the Cheaha HPC cluster.
This tool provides essential information for new users getting started with
the Cheaha high-performance computing cluster at UAB. No parameters required.
Returns:
Quick start guide with essential information for Cheaha access and basic usage |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
| search_cheaha_help | Search UAB Research Computing documentation for help with a specific topic. Useful for finding information about Cheaha HPC, SLURM jobs, software, storage, and other research computing topics. Args: topic: The topic to search for (default: "getting started") Returns: A prompt to search the documentation |
| how_to_submit_slurm_job | Get help with submitting SLURM jobs on Cheaha HPC cluster. Provides guidance on creating job scripts, resource requests, and best practices for job submission. Returns: A prompt to guide job submission assistance |
| find_available_software | Find information about available software on Cheaha HPC. Helps users locate and use specific software packages, including how to load modules and check versions. Args: software_name: The name of the software to find Returns: A prompt to search for software information |
| get_help_and_support | Get information about UAB Research Computing support options. Provides office hours, contact information, and support channels. Returns: A prompt to retrieve support information |
| cheaha_getting_started | Get started with Cheaha HPC cluster. Provides essential information for new users including access, basic usage, and key resources. Returns: A prompt to get quick start information |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |