universalis-mcp-server 0.2.0 → 0.2.1

package/docs/wiki/saddlebag/tldr-how-to-earn-gil-with-cross-server-trading.md

@@ -0,0 +1,89 @@
+#  How to Earn Gold with Cross Realm Trading 
+
+Simple buy low in one realm, deposit an item in your warband bank, move it to another realm and sell high!
+
+[ Watch this tutorial](https://youtu.be/31ey9tEPyTQ?t=160) if you're new to cross realm trading. It covers how to move items from one realm to another for trading.
+
+##  TL;DR: How to Make Gil with a 4-Step Process
+
+Here are some of the top ways to use Saddlebag for FFXIV, made simple for new users:
+
+### 1.  **Learn What to Sell and How Much to Sell It For** 
+
+Use the reselling, marketshare, best deals or craftsim searches to find good items to sell or craft (if youre an omnicrafter) and determine the average price you can sell them for:
+
+-  [Reselling Trade Search](https://saddlebagexchange.com/queries/recommended)
+-  [Best Deals](https://saddlebagexchange.com/ffxiv/best-deals/recommended)
+-  [Marketshare](https://saddlebagexchange.com/ffxiv/marketshare/queries)
+-  [Craftsim Search](https://saddlebagexchange.com/ffxiv/craftsim/queries)
+-  [Currency Conversion Search](https://saddlebagexchange.com/ffxiv/scrip-exchange)
+-  [Secret Sale Leads](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/FFXIV-Sale-Leads)
+
+### 2.  **Buy Low**
+
+Search for good deals on those items using the [Experimental Discount Sniper](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/FFXIV-Experimental-Discount-Price-Sniper), reselling search, shopping list, or best deals, then buy them if not crafting. If you are crafting, use the [Discord bot price-alert](https://saddlebagexchange.com/price-sniper) to know when there are deals on your raw materials:
+
+-  [Reselling Trade Search](https://saddlebagexchange.com/queries/recommended)
+-  [Best Deals](https://saddlebagexchange.com/ffxiv/best-deals/recommended)
+-  [Discord Bot Price-Alert](https://saddlebagexchange.com/wow/price-alert)
+-  [Experimental Discount Sniper](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/FFXIV-Experimental-Discount-Price-Sniper)
+-  [Bulk Crafting Shopping List](https://saddlebagexchange.com/wow/shopping-list)
+
+### 3.  **Sell High**
+
+In FFXIV you don't really need to make many alts and sell on different servers, our tools are geared towards selling on your own home server. Unlike WoW where you can make a fresh alt and start selling in 10 seconds, FFXIV requires you level to 20 and that can take time to make alts on each server.  Its not really needed unless you really want to hardcore gil grind.
+
+However if you have many alts and 2 accounts to move items between them, then you can sell anywhere! Use the export search to find the best realm with the highest population to sell any items you buy or craft.
+
+-  [Export Search](https://saddlebagexchange.com/queries/world-comparison)
+
+### 4.  **Check for Sales and Undercuts**
+
+Use our alerts or allagan tool integration to help monitor your active listings and alert you when you should relist your items or when sales are made:
+
+-  [Allagan Tools Search](https://saddlebagexchange.com/allagan-data)
+-  [Discord Bot Undercut and Sale Alerts](https://saddlebagexchange.com/undercut)
+-  [Self Purchase History Search](https://saddlebagexchange.com/ffxiv/self-purchase)
+___
+
+```mermaid 
+flowchart LR
+    Start((Start)) --> Step1[ Learn What to Sell and How Much to Sell It For ]
+    
+    subgraph Step 1 Research
+        Step1 --> S1A[Open Reselling, Marketshare, Best Deals, Craftsim, or Scrip Exchange]
+        S1A --> S1B[Find profitable items to sell or craft]
+        S1B --> S1C[Note average sale price and demand]
+        S1C --> S1D[Optionally check Secret Sale Leads for niche ideas]
+    end
+    
+    Step1 --> Step2[ Buy Low]
+    
+    subgraph Step 2 Snipe Deals
+        Step2 --> S2A[Search for underpriced listings]
+        S2A --> S2B[Use Experimental Discount Sniper, Best Deals, or Shopping List]
+        S2B --> S2C{Are you crafting items?}
+        S2C -- Yes --> S2D[Use Discord bot price-alert for cheap raw materials]
+        S2C -- No --> S2E[Buy finished items directly for resale]
+    end
+    
+    Step2 --> Step3[ Sell High]
+    
+    subgraph Step 3 List Items
+        Step3 --> S3A[Use Export Search]
+        S3A --> S3B[Find the best world/DC or confirm your home server]
+        S3B --> S3C[List items on retainers at target prices]
+    end
+    
+    Step3 --> Step4[ Check for Sales and Undercuts]
+    
+    subgraph Step 4 Monitor & Adjust
+        Step4 --> S4A[Use Allagan Tools data and Discord undercut/sale alerts]
+        S4A --> S4B[Check active listings for undercuts]
+        S4B --> S4C[Relist items or adjust prices when needed]
+        S4C --> S4D[Review Self Purchase History to see what actually sells]
+    end
+    
+    Step4 --> End((Profit & Repeat))
+
+```

package/docs/wiki/universalis/api-app-overview.md

@@ -0,0 +1,236 @@
+## API Overview
+
+```mermaid
+graph TD
+    subgraph Client
+        Browser
+    end
+
+    subgraph Server
+        API["API Server (.NET 6)"]
+        Transformations["Data Transformations (F#)"]
+        DB[(MariaDB / PostgreSQL)]
+        Redis[(Redis)]
+    end
+
+    subgraph External
+        Game["Final Fantasy XIV"]
+        Uploader["ACT Plugin (Uploader)"]
+    end
+
+    Game --> Uploader --> API
+    Browser --> API
+    API -->|Reads/Writes| DB
+    API -->|Caching| Redis
+    Transformations -->|Processes Data| DB
+    Transformations --> Redis
+
+```
+
+### **Root Directory**
+
+- **Dockerfile**: Defines the Docker image configuration for building and running the application in a containerized environment.
+
+- **LICENSE**: Contains the licensing terms under which the project is distributed.
+
+- **README.md**: The main documentation file providing an overview of the project, usage instructions, and other relevant information.
+
+- **Universalis.sln**: The Visual Studio solution file that includes all the projects within the repository.
+
+- **build.cmd**, **build.sh**, **build.ps1**: Scripts for building the project on Windows (`.cmd`), Unix/Linux (`.sh`), and PowerShell (`.ps1`) platforms.
+
+### **Directories**
+
+#### **build/**
+
+Contains build scripts and configuration files for compiling and building the project.
+
+- **Build.cs**, **Configuration.cs**: C# scripts that manage the build process and configurations.
+
+- **Directory.Build.props**, **Directory.Build.targets**: MSBuild properties and targets applied to all projects in the solution.
+
+- **Properties/launchSettings.json**: Defines settings for launching the application during development.
+
+- **_build.csproj**, **_build.csproj.DotSettings**: Project files for the build scripts.
+
+#### **deployment/**
+
+Contains deployment configurations and resources.
+
+- **docker-compose.yml**: Docker Compose file for deploying the application and its services.
+
+- **prometheus.yml**: Configuration file for Prometheus monitoring.
+
+- **README.md**: Documentation related to deployment processes.
+
+#### **devenv/**
+
+Contains development environment setup configurations.
+
+- **docker-compose.yml**: Docker Compose file for setting up the development environment.
+
+- **prometheus.yml**: Configuration for monitoring in the development environment.
+
+- **README.md**: Documentation on setting up and using the development environment.
+
+- **sqlinit/**: Contains SQL scripts for initializing the database.
+
+    - **01-GrantUserPrivileges.sql** to **17-SeedUserAlertEventsTable.sql**: Scripts for creating databases, tables, and seeding initial data.
+
+- **websocket-client/**: Contains a sample WebSocket client for testing purposes.
+
+    - **index.js**: JavaScript implementation of the WebSocket client.
+
+    - **package.json**, **package-lock.json**: Node.js package configuration files.
+
+#### **src/**
+
+The main source code directory containing all the application modules.
+
+##### **Universalis.Application/**
+
+The core application project.
+
+- **Program.cs**: The entry point of the application.
+
+- **Startup.cs**: Configures services and the application's request pipeline.
+
+- **appsettings.json**: Application configuration settings.
+
+- **Common/**: Contains common utilities and helpers.
+
+    - **IPriceable.cs**, **InputProcessing.cs**, etc.: Interfaces and classes used across the application.
+
+- **Controllers/**: Contains API controllers for handling HTTP requests.
+
+    - **V1/**, **V2/**, **V3/**: Controllers for different API versions.
+
+        - **V1/CurrentlyShownController.cs**: Handles requests for current market board data.
+
+        - **V1/HistoryController.cs**: Handles requests for historical market data.
+
+        - **V2/AggregatedMarketBoardDataController.cs**: Provides aggregated market data.
+
+        - **V3/Game/**: Controllers related to game data.
+
+            - **DataCentersController.cs**, **WorldsController.cs**: Provide data center and world (server) information.
+
+        - **V3/Market/**: Controllers related to market data.
+
+            - **OverviewController.cs**, **SalesController.cs**: Provide market overview and sales data.
+
+- **ExceptionFilters/**: Contains filters for global exception handling.
+
+- **Realtime/**: Implements real-time data handling and WebSocket support.
+
+    - **Messages/**: Defines message formats for real-time events.
+
+    - **SocketProcessor.cs**: Processes WebSocket connections and messages.
+
+- **Uploads/**: Handles data uploads, including schemas and behaviors.
+
+    - **Schema/**: Defines data schemas for uploads.
+
+    - **Behaviors/**: Defines behaviors for processing uploads.
+
+- **Views/**: Contains view models used by the controllers to structure response data.
+
+    - **V1/**, **V2/**, **V3/**: View models for different API versions.
+
+##### **Universalis.Alerts/**
+
+Handles alerting functionality within the application.
+
+- **DiscordAlertsProvider.cs**: Provides alert notifications via Discord.
+
+- **AlertExtensions.cs**, **IDiscordAlertsProvider.cs**: Supporting classes and interfaces for alerting features.
+
+##### **Universalis.Common/**
+
+Contains common code and utilities shared across different modules.
+
+- **Caching/**: Interfaces and implementations for caching mechanisms.
+
+- **GameData/**: Provides access to game data such as items, worlds, and data centers.
+
+##### **Universalis.DbAccess/**
+
+Data access layer for interacting with databases and Redis.
+
+- **AccessControl/**: Manages API keys and trusted sources for access control.
+
+- **MarketBoard/**: Data access code specific to market board data.
+
+- **Uploads/**: Data access code for uploads and statistics.
+
+- **Migrations/**: Database migration scripts for schema changes.
+
+- **Metrics/**: Integration with Prometheus for metrics collection.
+
+- **RedisDatabases.cs**, **Util.cs**, etc.: Utility classes for database operations.
+
+##### **Universalis.Entities/**
+
+Defines entity models representing data structures used throughout the application.
+
+- **AccessControl/**, **MarketBoard/**, **Uploads/**: Entities related to their respective domains.
+
+- **Materia.cs**, **TradeVelocity.cs**, etc.: Specific entities used in market data and other functionalities.
+
+##### **Universalis.GameData/**
+
+Provides implementations for accessing game-related data.
+
+- **DataCenter.cs**, **World.cs**, **IGameDataProvider.cs**: Classes and interfaces for game data.
+
+##### **Universalis.Mogboard/**
+
+Contains code for integrating with Mogboard, the frontend application.
+
+- **Entities/**: Data structures for user lists and other shared entities.
+
+- **Doctrine/**: Parsers and serializers for Doctrine types used in Mogboard.
+
+- **UserListsService.cs**: Service for handling user lists.
+
+##### **Tests/**
+
+Contains test projects for various modules to ensure code quality and correctness.
+
+- **Universalis.Application.Tests/**: Tests for the application layer.
+
+- **Universalis.DbAccess.Tests/**: Tests for the data access layer.
+
+- **Universalis.GameData.Tests/**: Tests for game data access code.
+
+- **Universalis.Mogboard.Tests/**: Tests for Mogboard integration.
+
+- **Universalis.DataTransformations.Tests/**: Tests for data transformation logic.
+
+- **Universalis.Tests/**: General tests for the Universalis project.
+
+---
+
+### **Overview**
+
+The **Universalis** repository is a .NET application serving as a crowdsourced market board aggregator for **Final Fantasy XIV**. It provides APIs for retrieving market data, supports real-time updates via WebSockets, and integrates with a frontend application called **Mogboard**.
+
+Key components and features include:
+
+- **API Controllers**: Serve market data through RESTful endpoints, supporting multiple API versions.
+
+- **Data Access Layer**: Interacts with relational databases (**PostgreSQL**, **MariaDB**) and caching systems (**Redis**) to store and retrieve market data.
+
+- **Real-Time Data**: Implements WebSocket support for real-time market updates.
+
+- **Uploads Handling**: Processes data uploads from trusted sources, including validation and aggregation.
+
+- **Alerts System**: Sends notifications and alerts via platforms like Discord.
+
+- **Game Data Integration**: Provides access to game-specific data such as items, worlds, and data centers.
+
+- **Deployment Configurations**: Uses **Docker** and **Docker Compose** for containerization, easing deployment and development setup.
+
+- **Monitoring and Metrics**: Integrates with **Prometheus** for collecting metrics and monitoring the application's performance.
+
+- **Testing**: Comprehensive test suites across various modules to ensure reliability and correctness.

package/docs/wiki/universalis/how-to-help-update-the-data-on-universalis.md

@@ -0,0 +1,21 @@
+# How to Update Universalis
+
+The data on Universalis is **crowdsourced**, meaning you have the power to update Universalis yourself! To contribute, install software like the [Dalamud Plugins FFXIV Quick Launcher](https://goatcorp.github.io/) or the [TeamCraft Desktop App](https://github.com/ffxiv-teamcraft/ffxiv-teamcraft/releases/latest). Once installed all you have to do is you visit the marketboard and look up items, the listings and history you see in-game of the items you look up will be sent to Universalis.
+
+See all supported software here: [Supported Software](https://universalis.app/contribute).
+
+## Updating Retainer Prices Does Not Update Universalis
+
+Note that Universalis is only updated when you look up items on the marketboard. It is not updated when you change prices in your retainers. After you update prices, be sure to return to the marketboard and look up your items to ensure they get updated.
+
+## If You Don't Update, Someone Eventually Will!
+
+You don't have to do this all yourself! This is where the **crowdsourced** aspect becomes important. If you don't look up the items, eventually someone with the Quick Launcher or TeamCraft will look them up and update the items for you.
+
+## How to Get Help If You Do Not Play on PC
+
+If you do not play on PC, you cannot update Universalis yourself. If you want specific items updated, you can ask in the Universalis [Data Requests](https://discord.com/channels/616826096897228801/1192666174559891627) channel, and a PC player will assist you.
+
+## Note on Privacy
+
+There are multiple ways to contribute to Universalis, and all of your contributions are anonymous. No one will be able to refer back to your character or account to know that you have uploaded any data. The applications mentioned are tested by us to ensure they do not endanger your account or characters.

package/docs/wiki/universalis/how-to-make-universalis-lists.md

@@ -0,0 +1,24 @@
+****A universalis list can help you track multiple items all at once, and provide API functionality!****
+
+1. To add an item to a list, click on the LISTS button on any item overview page:
+
+<img width="1009" alt="image" src="https://user-images.githubusercontent.com/17516896/230792991-0f2e478c-6966-4c71-aa10-4cd1ca854074.png">
+
+2. Upon clicking a box will show allowing you to either add the item to an existing list or create a brand-new one.
+
+<img width="416" alt="image" src="https://user-images.githubusercontent.com/17516896/230793037-d65ff642-da23-4b17-9c2f-c0afd75348b9.png">
+
+3. This is where you will navigate to your homepage to select the list for an overview of the lowest prices for those items in your **data center.** This is displayed the same way
+as your [Favorites List](https://github.com/Universalis-FFXIV/guides/wiki/How-to-use-Universalis-Favorites).
+
+<img width="922" alt="image" src="https://user-images.githubusercontent.com/17516896/230793092-a0d125ef-ae8d-4e48-97c2-d77764f53b1c.png">
+
+These lists are extremely useful for API applications. You can view details on how to make these API calls for your list [on the developer documentation](https://docs.universalis.app/#user-lists).
+
+If you click on your universalis list, the following page will appear with more details on your select items.  The URL ending is where the LIST ID of your universalis list is located:
+
+<img width="1123" alt="image" src="https://user-images.githubusercontent.com/17516896/230793386-64175ff6-fef3-477e-a075-4349eb087803.png">
+
+Plugging said information into the developer API will list the item IDs of all the items on your list:
+
+<img width="1222" alt="image" src="https://user-images.githubusercontent.com/17516896/230793443-44dc419c-2914-459e-877d-b36b6620549d.png">

package/docs/wiki/universalis/how-to-search-for-items-on-universalis-and-saddlebag-exchange.md

@@ -0,0 +1,56 @@
+There are many different methods of searching the data available on Universalis to be covered in this guide. 
+
+[Saddlebag Exchange](https://saddlebagexchange.com/queries) is a second project which uses Universalis API data to provide advanced search functions for Universalis.
+
+Together with both projects you are able to search for FFXIV marketable items in the following ways:
+
+- [Search for a single item by item name](https://github.com/Universalis-FFXIV/guides/wiki/How-to-search-for-items-on-Universalis-and-Saddlebag-Exchange#search-for-a-single-item-by-item-name)
+- [Search for a single item by item category](https://github.com/Universalis-FFXIV/guides/wiki/How-to-search-for-items-on-Universalis-and-Saddlebag-Exchange#search-for-a-single-item-by-item-category)
+- [Search and compare multiple items by Sale Rate and Average Sale Price](https://github.com/Universalis-FFXIV/guides/wiki/How-to-search-for-items-on-Universalis-and-Saddlebag-Exchange#search-for-multiple-items-by-sale-rate-and-average-sale-price)
+- [Search and compare multiple items to resell for a profit](https://github.com/Universalis-FFXIV/guides/wiki/How-to-search-for-items-on-Universalis-and-Saddlebag-Exchange#search-for-items-to-resell-for-a-profit)
+- [Search using Developer API's](https://github.com/Universalis-FFXIV/guides/wiki/How-to-search-for-items-on-Universalis-and-Saddlebag-Exchange#search-using-developer-apis)
+
+## Search for a single item by item name
+
+You can search for a specific item by name in the search bar on the main Universalis website.
+
+This will show you a general overview of the item with the current 10 lowest priced listings available and 10 most recent sales.
+
+This can be filtered to listings and history on different servers, datacenter's and regions. See [the user guide on the item page navigation](https://github.com/Universalis-FFXIV/guides/wiki/Navigating-an-item-overview-on-Universalis) for more details.
+
+<img width="701" alt="image" src="https://user-images.githubusercontent.com/17516896/229619968-4ade0c18-ca52-4e77-9a9e-8d5b97388dd7.png">
+
+<img width="1440" alt="image" src="https://user-images.githubusercontent.com/17516896/229621186-3365cd86-5ddd-4ae0-9a7f-3d0bc66a9337.png">
+
+## Search for a single item by item category
+
+You can used the Universalis side bar to scroll by item category and sub category to find specific items.  This will bring you to the items Universalis page.
+
+![image](https://user-images.githubusercontent.com/17516896/229626155-2dab7757-ebf9-410c-957a-6f2029b091c1.png)
+
+## Search for multiple items by Sale Rate and Average Sale Price
+
+If you want to search by a sales statistic like `Rate of Sales` or `Average Sale Price` you can search the universalis data using the `Market Overview Search` from the website [Saddlebag Exchange](https://saddlebagexchange.com/ffxiv/marketshare/queries).
+
+This website will help you find the fastest selling items, the items that earn the most gil, the items which increased in price the most and more!
+
+Check out their [Market Overview Guide](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/How-to-trade-using-our-FFXIV-Market-Overview) for more information.
+
+![image](https://user-images.githubusercontent.com/17516896/229621782-d9d068a8-5ca2-444f-b2bb-1d01cccfcfa5.png)
+
+![image](https://user-images.githubusercontent.com/17516896/229699079-e4ce49e7-8be3-4154-b275-16d32b2ddd4e.png)
+
+
+## Search for items to resell for a profit
+
+If you want to find opportunities to profit from buying items on other servers to resell on your own [Saddlebag Exchange](https://saddlebagexchange.com/queries/recommended) has a reselling trade search with many options and premade filters designed to find great reselling opportunities. The search is 100% customizable and easy to bookmark if you wish to create your own searches.
+
+Check out their [Reselling Trade Search Guide](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/How-to-Import,-Trade-and-Flip-items-on-the-FFXIV-Marketboard-using-Saddlebag-Exchange-Import-Searches) for more information.
+
+![image](https://user-images.githubusercontent.com/17516896/229623454-53f93df8-ca29-48b8-a051-5d2b1d6c4bb1.png)
+
+## Search using Developer API's
+
+You can access the full universalis data directly using the Dev API. To find more information check out the [API Documentation here](https://universalis.app/docs/index.html).
+
+Saddlebag Exchange also has an api to access their searches.  You can check out their API guide [here](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/API-Call-Guide).

package/docs/wiki/universalis/how-to-setup-universalis-alerts.md

@@ -0,0 +1,54 @@
+## Universalis Discord Webhooks
+
+Universalis offers Discord webhooks that allow you to receive simple price and quantity-based alerts on your home server in a Discord channel you own.
+
+For more user-friendly alerts with additional options designed to help you earn more gil, check out the [Saddlebag Exchange](https://saddlebagexchange.com/) alerts in their [Discord server](https://discord.gg/836C8wDVNq).
+
+### Available Alerts
+
+- [Undercut Alerts](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/Undercut-Alerts---Alpha-version)
+- [Price Sniper Alerts](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/Price-Sniper-and-Item-Price-Alerts)
+- [Sale Alerts](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/FFXIV-Sale-Alerts)
+- [Shortage Quantity Alerts](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/Price-Sniper-and-Item-Price-Alerts)
+
+## Example Alerts
+
+![Example Alert](https://user-images.githubusercontent.com/17516896/229619099-6b995011-3a3e-4c9e-84b3-83c6969f9f7f.png)
+
+## Setup Instructions
+
+Follow these steps to set up your alerts:
+
+1. **Login to Universalis with Discord:**
+
+   ![Login Screenshot](https://user-images.githubusercontent.com/17516896/229612628-dd40f9a7-da61-4f96-b604-e3da0f0f8d66.png)
+
+2. **Search for Your Favorite Items:**
+
+   ![Search Items Screenshot](https://user-images.githubusercontent.com/17516896/229612942-00d03385-a08f-46f0-8f41-c5421c4d1ce8.png)
+
+3. **Create a Discord Webhook:**
+
+   Create a webhook on a Discord channel you manage or have admin permissions over. Check out the [Discord documentation for setting up webhooks](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) if you need assistance.
+
+4. **Select the Alerts Button:**
+
+   Click the Alerts button on an item you wish to monitor and create a new alert.
+
+   ![Select Alerts Screenshot](https://user-images.githubusercontent.com/17516896/229613136-d7547644-8574-4be7-b828-51a00a4df32a.png)
+
+   ![Alert Options Screenshot](https://user-images.githubusercontent.com/17516896/229613217-346c130b-de8c-4a9c-921c-5efc60fd0334.png)
+
+5. **Enter Your Alert Triggers:**
+
+   Customize your alert with the following options:
+
+   - **Name:** Give your alert a name.
+   - **World:** Select which server you wish to monitor.
+   - **Filter:** Specify if you want alerts only for HQ items. Leave blank for all qualities.
+   - **Using:** Choose between `Unit Price`, `Total`, or `Quantity` to set which metrics trigger alerts.
+   - **Calculate:** Choose `Minimum`, `Maximum`, or `Average` based on the metric selected in the `Using` field.
+   - **Compare:** Set `Result is greater than` or `Result is less than` to alert when the calculated value meets your criteria.
+   - **Discord Webhook:** Paste your Discord webhook URL from step 3.
+
+   ![Alert Triggers Screenshot](https://user-images.githubusercontent.com/17516896/229616025-f7f23e2a-004a-45b5-970c-3a6ecf31f566.png)

package/docs/wiki/universalis/how-to-use-universalis-favorites.md

@@ -0,0 +1,17 @@
+## What is a Favorites List?
+The Favorites list helps provide quick links and overviews for your selection of favorite items.
+
+<img width="502" alt="image" src="https://user-images.githubusercontent.com/17516896/230792808-82584184-901c-4914-b2bd-fcae32d6586e.png">
+
+# Adding to the favorites list
+Click the "Favourites" button on any universalis page for any item as shown below.
+
+<img width="1022" alt="image" src="https://user-images.githubusercontent.com/17516896/230792734-c55e94d9-d930-4904-b281-8aa7d19c746e.png">
+
+Then go to the [Universalis Home Page](https://universalis.app) and click the favorites button:
+
+<img width="1230" alt="image" src="https://user-images.githubusercontent.com/17516896/230792769-2367a524-127e-4fcb-8a96-4b2cabb2a1fc.png">
+
+You will then be presented with a favorites box with information on the ****cheapest**** source in your datacenter.
+
+<img width="1225" alt="image" src="https://user-images.githubusercontent.com/17516896/230792885-99a0727b-c65f-4ed6-8d43-723bb91980e7.png">

package/docs/wiki/universalis/interactive-tutorials.md

@@ -0,0 +1,3 @@
+Check out our step by step guides on how to use universalis.  Just click through the guide and it shows you how to use the website:
+
+- [Universalis Lists](https://app.supademo.com/embed/clukcr98c0p1912me0g4mm9ln)

package/docs/wiki/universalis/navigating-an-item-overview-on-universalis.md

@@ -0,0 +1,72 @@
+Each universalis item overview page has several options and different ways to view information on a particular item. This guide covers:
+
+- [Navigation Bar, Links and Menus](https://github.com/Universalis-FFXIV/guides/wiki/Navigating-an-item-overview-on-Universalis#navigation-bar-links-and-menus)
+- [Single Server Overview](https://github.com/Universalis-FFXIV/guides/wiki/Navigating-an-item-overview-on-Universalis#single-server-overview)
+- [Datacenter Overview](https://github.com/Universalis-FFXIV/guides/wiki/Navigating-an-item-overview-on-Universalis#datacenter-overview)
+- [Region Wide overview](https://github.com/Universalis-FFXIV/guides/wiki/Navigating-an-item-overview-on-Universalis#region-wide-overview)
+
+## Navigation Bar, Links and Menus
+
+<img width="1238" alt="image" src="https://user-images.githubusercontent.com/17516896/229813286-7e05573b-1771-4362-be91-17dfe3b53006.png">
+
+The top of each universalis item page shows information on the name of the item, item category, item subcategory and the item description.
+
+<img width="1046" alt="image" src="https://user-images.githubusercontent.com/17516896/230271518-b965bf08-6596-434b-8e1c-7cbb40b3f9a8.png">
+
+The bar of servers, data centers and your regions name will show you different data for the listings and history on different scales.
+
+<img width="664" alt="image" src="https://user-images.githubusercontent.com/17516896/230271475-ec9f70f5-8ed9-4230-8fbf-960ba3dd363a.png">
+
+In the top right there are 3 buttons for your universalis lists, favorites, alerts and user menu. For more information on these features check out the following guides:
+
+- [How to set up Universalis Alerts](https://github.com/Universalis-FFXIV/guides/wiki/How-to-setup-Universalis-Alerts)
+- [How to use Universalis Favorites](https://github.com/Universalis-FFXIV/guides/wiki/How-to-use-Universalis-Favorites)
+- [How to make Universalis Lists](https://github.com/Universalis-FFXIV/guides/wiki/How-to-make-Universalis-Lists)
+
+There are also buttons linking to 3 other websites with more information on any marketable item:
+
+- [Saddlebag Exchange](http://saddlebagexchange.com/): Showing advanced statistics on the item determined from the data on universalis.  You can find more information on the SE item statistics [here in their guide](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/How-to-use-Item-Data-Searches-to-help-you-find-good-items-to-trade).
+
+<img width="445" alt="image" src="https://user-images.githubusercontent.com/17516896/230269764-99307640-55e0-4cb6-b766-ae26ece0c729.png">
+
+<img width="442" alt="image" src="https://user-images.githubusercontent.com/17516896/230269795-c6a52197-4330-4def-bc1a-c33b5dbf02d2.png">
+
+<img width="449" alt="image" src="https://user-images.githubusercontent.com/17516896/230269825-3224646a-2ca3-4e9a-a1c7-cc66835555c4.png">
+
+<img width="442" alt="image" src="https://user-images.githubusercontent.com/17516896/230269881-176ba9db-e5e1-4a56-861c-8b5d5fd318d0.png">
+
+<img width="447" alt="image" src="https://user-images.githubusercontent.com/17516896/230269850-6ad4cb14-ab02-4a24-baa3-f99b11ed8a36.png">
+
+
+- [Garland Tools](https://www.garlandtools.org/): Providing information on related uses and achievements:
+
+<img width="1440" alt="image" src="https://user-images.githubusercontent.com/17516896/230269264-e4930f32-6010-4311-9dd9-2d2d3a9ac510.png">
+
+- [Teamcraft](https://ffxivteamcraft.com/): Providing crafting data and information:
+
+<img width="1439" alt="image" src="https://user-images.githubusercontent.com/17516896/230269367-2e06228a-aed5-463c-9d35-71947d957355.png">
+
+
+## Single Server Overview
+
+This view will show you the lowest 10 listings and last 10 sales on your home server or any individual server in your home datacenter.
+
+The purchase history graph will show you the HQ and NQ sale prices over time.
+
+The Stack Size Histogram will show you what stack sizes are listed for items that can be sold in stacks of more than 1.
+
+<img width="1305" alt="image" src="https://user-images.githubusercontent.com/17516896/229696787-0c740cb2-628f-4ac3-8556-654203156136.png">
+
+## Datacenter Overview
+
+The datacenter overview will show you the last 10 sales and all listings in your datacenter or other datacenters in your region.
+
+<img width="786" alt="image" src="https://user-images.githubusercontent.com/17516896/229697001-96e478c7-e285-4f37-bccf-0d81c61dbc34.png">
+
+## Region Wide Overview
+
+The datacenter overview will show you the last 10 sales and all listings in your region across all datacenters.
+
+![image](https://user-images.githubusercontent.com/17516896/229697356-457021ba-6aa0-4519-bebb-84ad4bc52139.png)
+
+<img width="787" alt="image" src="https://user-images.githubusercontent.com/17516896/229697332-8d7c655c-c7e3-4543-a58e-781eca56af38.png">

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "universalis-mcp-server",
-  "version": "0.2.0",
-  "description": "MCP server for Universalis and XIVAPI",
+  "version": "0.2.1",
+  "description": "MCP server for Universalis, Saddlebag Exchange, and XIVAPI",
   "author": "Jakub Mucha <jakub.mucha@icloud.com>",
   "repository": {
     "type": "git",
@@ -18,7 +18,8 @@
   },
   "files": [
     "dist",
-    "data"
+    "data",
+    "docs/wiki"
   ],
   "keywords": [
     "mcp",
@@ -40,6 +41,7 @@
   "scripts": {
     "build": "tsc && chmod 755 ./dist/index.js",
     "update-materia": "node scripts/update-materia-data.js",
+    "update-wiki-docs": "node scripts/update-wiki-docs.mjs",
     "lint": "biome check .",
     "format": "biome format --write ."
   }