{"id":"d7812d02-a8e4-4932-8e12-202cb5170ea9","slug":"appsage","kind":"mcp","name":"appsage","summary":"","owner":"awslabs","repoUrl":"https://github.com/awslabs/appsage","license":"Apache-2.0","licenseTier":"permissive","trust":"official","stars":2,"match":null,"fewStars":false,"format":"mcp","createdAt":"2025-09-16T01:11:57.000Z","addedAt":"2026-10-21T15:54:57.011Z","logoUrl":"https://avatars.githubusercontent.com/u/3299148?v=4","linkOnly":false,"collection":null,"skillPath":null,"categories":["utilities"],"tags":[],"runtime":"binary","local":true,"cloudCapable":false,"cloudCapability":"unknown","cloudReadyOnPlatform":false,"needsApiKey":false,"reviewed":false,"syncedAt":"2026-10-21T15:56:23.587Z","sample":false,"url":"https://conduits.dev/tools/appsage","language":"C#","transports":["stdio"],"install":{},"requirements":{"env":[],"upstreamMayCharge":false},"tools":null,"readme":"# AppSage\n\nAppSage is a comprehensive software analysis and visualization platform that helps developers understand and analyze their codebases through metrics, documentation generation, and interactive visualizations.\n\n## Table of Contents\n\n- [Prerequisites](#prerequisites)\n- [Building the Project](#building-the-project)\n- [Installation](#installation)\n- [Basic Usage](#basic-usage)\n- [MCP Server Integration](#mcp-server-integration)\n- [Security](#security)\n- [License](#license)\n\n## Prerequisites\n\n### Prerequisites to Build\n\n- **.NET core SDK 10.0+**: Required to build the AppSage .NET applications\n  - Download from [Microsoft .NET Downloads](https://dotnet.microsoft.com/download)\n  - Verify installation: `dotnet --version`\n\n- **PowerShell 5.1+ or PowerShell Core 6+**: Required for build scripts\n  - Windows: Built-in PowerShell 5.1 or install PowerShell Core\n  - Cross-platform: Install PowerShell Core\n\n- **Node.js 16+**: Required for VS Code extension development\n  - Download from [Node.js](https://nodejs.org/)\n  - Verify installation: `node --version`\n\n- **TypeScript 4.9+**: Required for VS Code extension\n  - Install globally: `npm install -g typescript`\n\n### Prerequisites to Run\n\n- **.NET Runtime 10.0+**: Required to run AppSage applications\n- **Visual Studio Code latest version**: Required for the AppSage VS Code extension\n- **Git**: Required for repository analysis features\n\n## Building the Project\n\nTo build AppSage from source:\n\n1. **Clone the repository**:\n   ```powershell\n   git clone https://github.com/awslabs/appsage.git\n   cd appsage\n   ```\n\n2. **Build the complete project** using the installer creation script:\n   ```powershell\n   cd src\\Installer\n   .\\Create-Installer.ps1 -Configuration Release\n   ```\n\n   Optional parameters:\n   - `-Configuration Debug|Release` (default: Release)\n   - `-Version x.y.z` (uses version from Directory.Build.props if not specified)\n\n   This script will:\n   - Clean old build artifacts\n   - Build the .NET solution\n   - Publish the AppSage.Run application\n   - Build the VS Code extension\n   - Create a packaged installer zip file\n\n3. **Build output**: The installer will be created as `AppSage-Installer-v{version}.zip` in the `src/Installer` directory.\n\n## Installation\n\n### Installing from the Built Package\n\n1. **Extract the installer**:\n   ```powershell\n   Expand-Archive -Path \"AppSage-Installer-v{version}.zip\" -DestinationPath \"AppSage-Installer\"\n   cd AppSage-Installer\n   ```\n\n2. **Run the installation script**:\n   ```powershell\n   .\\Install-AppSage.ps1\n   ```\n\n   Installation options:\n   ```powershell\n   # Install to default location (C:\\Program Files\\AppSage)\n   .\\Install-AppSage.ps1\n\n   # Install to custom location\n   .\\Install-AppSage.ps1 -InstallPath \"C:\\Tools\\AppSage\"\n\n   # Install for current user only\n   .\\Install-AppSage.ps1 -Scope User\n   ```\n\n3. **Verify installation**:\n   ```powershell\n   appsage --version\n   ```\n\n### Installing the VS Code Extension\n\nAfter running the installer, install the VS Code extension:\n\n1. **From the installer package**:\n   ```bash\n   code --install-extension appsage-vscode-extension-{version}.vsix\n   ```\n\n2. **Alternative manual installation**:\n   - Open VS Code\n   - Press `Ctrl+Shift+P` and type \"Extensions: Install from VSIX\"\n   - Select the `appsage-vscode-extension-{version}.vsix` file from the installer\n\n## Basic Usage\n\n### Initial Setup\n\n1. **Initialize a new AppSage workspace**:\n   ```powershell\n   mkdir MyProject\n   cd MyProject\n   appsage init\n   ```\n\n   This creates the AppSage workspace structure with:\n   - `Repository/` - Source code repositories folder (each repository in separate subfolder)\n   - `Template/` - Analysis templates for bulk generation\n   - `ProviderOutput/` - Tooling output after code scanning\n   - `MCPServerOutput/` - Files generated by MCP server queries\n   - `TemplateBasedAnalysisOutput/` - Template-based analysis results\n   - `Logs/` - Application logs\n   - `Extension/` - Extension management folder\n     - `Packages/` - Extension NuGet packages (.nupkg, .snupkg)\n     - `Install/` - Installed extensions (one folder per extension)\n   - `.appsage/` - Hidden configuration folder\n     - `appsage.json` - Main workspace configuration file\n     - `cache/` - Internal caching directory\n   - `.vscode/` - VS Code workspace configuration\n     - `mcp.json` - MCP server configuration\n\n2. **Add repositories to analyze**:\n   ```powershell\n   # Copy or clone repositories into the Repository folder\n   cd Repository\n   git clone https://github.com/your-org/your-repo.git\n   # Or copy existing repositories here\n   ```\n\n3. **Run AppSage analysis**:\n   ```powershell\n   # Return to workspace root\n   cd ..\n   \n   # Run extension analysis\n   appsage extension run\n   ```\n\n### Common Commands\n\n- **Initialize workspace**: `appsage init`\n- **Run all extensions**: `appsage extension run`\n- **List available extensions**: `appsage extension list`\n\n### Viewing Results\n\nAppSage generates various output files that can be viewed with the VS Code extension:\n\n- **Graph files** (`.appsagegraph`): Visualize code relationships and dependencies\n- **Table files** (`.appsagetable`): View metrics and analysis data in tabular format\n\n## MCP Server Integration\n\nAppSage includes a Model Context Protocol (MCP) server for integration with AI tools and VS Code.\n\n### Starting the MCP Server\n\n1. **Navigate to your AppSage workspace**:\n   ```powershell\n   cd path\\to\\your\\appsage\\workspace\n   ```\n\n2. **Start the MCP server**:\n   ```powershell\n   appsage mcp start\n   ```\n\n   The server will start on `http://localhost:44000/mcp` by default.\n\n### Connecting from VS Code\n\n1. **Install an MCP-compatible VS Code extension** (such as Claude Dev or similar)\n\n2. **Configure the MCP connection**:\n   ```json\n   {\n     \"mcpServers\": {\n       \"appsage\": {\n         \"command\": \"appsage\",\n         \"args\": [\"mcp\", \"start\"],\n         \"transport\": \"http\",\n         \"url\": \"http://localhost:44000/mcp\"\n       }\n     }\n   }\n   ```\n\n### Example MCP Queries\n\nOnce connected, you can query AppSage through the MCP interface:\n\n**Analyze code metrics**:\n```\n@appsage Create a table listing all the methods and classes used in the project. \n```\n\n****:\n```\n@appsage Do an effort estimate to migrate SQL server classes to PostgreSQL\n```\n\n**Visualize dependencies**:\n```\n@appsage Create a dependency graph for the classes with more than 1 method. \n```\n\nThe MCP server provides access to:\n- **Tools**: Callable functions for running analyses and generating reports\n- **Prompts**: Pre-built templates for common analysis tasks  \n- **Resources**: Read-only access to workspace data and metrics\n\n## Security\n\nSee [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.\n\n## License\n\nThis project is licensed under the Apache-2.0 License.\n\n"}