# Development Workflow
## ๐จ **IMPORTANT: All Changes Must Use Pull Requests**
**Direct commits to `main` are not allowed.** All changes must go through the Pull Request (PR) process to ensure:
- Code review and quality control
- Proper version management
- CI/CD validation
- Documentation updates
## ๐ **Standard Development Workflow**
### 1. **Create Feature Branch**
```powershell
# Create and switch to feature branch
git checkout -b feature/your-feature-name
# Or for bug fixes
git checkout -b fix/issue-description
# Or for documentation updates
git checkout -b docs/update-description
```
### 2. **Make Your Changes**
```powershell
# Make code changes, add tests, update docs
# Commit frequently with clear messages
git add .
git commit -m "Add feature X with tests and documentation
- Implement core functionality
- Add comprehensive unit tests
- Update command documentation
- Include usage examples"
```
### 3. **Push Feature Branch**
```powershell
# Push your feature branch to GitHub
git push origin feature/your-feature-name
```
### 4. **Create Pull Request**
1. Go to [GitHub Repository](https://github.com/sbroenne/mcp-server-excel)
2. Click **"New Pull Request"**
3. Select your feature branch
4. Fill out the PR template:
- **Clear title** describing the change
- **Detailed description** of what was changed and why
- **Testing information** - what tests were added/run
- **Breaking changes** - if any
- **Documentation updates** - what docs were updated
### 5. **PR Review Process**
- **Automated checks** will run (build, tests, linting)
- **Code review** by maintainers
- **Address feedback** if requested
- **Merge** once approved and all checks pass
### 6. **After Merge**
```powershell
# Switch back to main and pull latest
git checkout main
git pull origin main
# Delete the feature branch (cleanup)
git branch -d feature/your-feature-name
git push origin --delete feature/your-feature-name
```
## ๐ท๏ธ **Release Process**
### Creating a New Release
**Only maintainers** can create releases. The process is:
1. **Ensure all changes are merged** to `main` via PRs
2. **Create and push a version tag**:
```powershell
# Create version tag (semantic versioning)
git tag v1.1.0
# Push the tag (triggers release workflow)
git push origin v1.1.0
```
1. **Automated Release Workflow**:
- โ
Updates version numbers in project files
- โ
Builds the release binaries
- โ
Creates GitHub release with ZIP file
- โ
Updates release notes
### Version Numbering
We follow [Semantic Versioning](https://semver.org/):
- **Major** (v2.0.0): Breaking changes
- **Minor** (v1.1.0): New features, backward compatible
- **Patch** (v1.0.1): Bug fixes, backward compatible
## ๐ **Branch Protection Rules**
The `main` branch is protected with:
- **Require pull request reviews** - Changes must be reviewed
- **Require status checks** - CI/CD must pass
- **Require up-to-date branches** - Must be current with main
- **No direct pushes** - All changes via PR only
## ๐งช **Testing Requirements & Organization**
### **Three-Tier Test Architecture**
ExcelMcp uses a **production-ready three-tier testing approach** with organized directory structure:
```
tests/
โโโ ExcelMcp.Core.Tests/
โ โโโ Unit/ # Fast tests, no Excel required (~2-5 sec)
โ โโโ Integration/ # Medium speed, requires Excel (~1-15 min)
โ โโโ RoundTrip/ # Slow, comprehensive workflows (~3-10 min each)
โโโ ExcelMcp.McpServer.Tests/
โ โโโ Unit/ # Fast tests, no server required
โ โโโ Integration/ # Medium speed, requires MCP server
โ โโโ RoundTrip/ # Slow, end-to-end protocol testing
โโโ ExcelMcp.CLI.Tests/
โโโ Unit/ # Fast tests, no Excel required
โโโ Integration/ # Medium speed, requires Excel & CLI
```
### **Development Workflow Commands**
**During Development (Fast Feedback):**
```powershell
# Quick validation - run tests for specific feature
dotnet test --filter "Feature=PowerQuery&RunType!=OnDemand"
dotnet test --filter "Feature=DataModel&RunType!=OnDemand"
```
**Before Commit (Comprehensive):**
```powershell
# Full local validation - runs in 10-20 minutes (excludes VBA)
dotnet test --filter "Category=Integration&RunType!=OnDemand&Feature!=VBA&Feature!=VBATrust"
```
**Session/Batch Code Changes (MANDATORY):**
```powershell
# When modifying ExcelSession.cs or ExcelBatch.cs
dotnet test --filter "RunType=OnDemand"
```
### **Test Categories & Guidelines**
**โ ๏ธ No Unit Tests** - See `docs/ADR-001-NO-UNIT-TESTS.md` for architectural rationale
**Integration Tests (`Category=Integration`)**
- โ
Test business logic with real Excel COM interaction
- โ
Medium speed (10-20 minutes for full suite)
- โ
Requires Excel installation
- โ
These ARE our unit tests (Excel COM cannot be mocked)
- โ
Run specific features during development
- โ
Slow execution (3-10 minutes each)
- โ
Verifies actual Excel state changes
- โ
Comprehensive scenario coverage
### **Adding New Tests**
When creating tests, follow these placement guidelines:
```csharp
// Unit Test Example
[Trait("Category", "Unit")]
[Trait("Speed", "Fast")]
[Trait("Layer", "Core")]
public class CommandLogicTests
{
// Tests business logic without Excel
}
// Integration Test Example
[Trait("Category", "Integration")]
[Trait("Speed", "Medium")]
[Trait("Feature", "PowerQuery")]
[Trait("RequiresExcel", "true")]
public class PowerQueryCommandsTests
{
// Tests single Excel operations
}
// Round Trip Test Example
[Trait("Category", "RoundTrip")]
[Trait("Speed", "Slow")]
[Trait("Feature", "EndToEnd")]
[Trait("RequiresExcel", "true")]
public class VbaWorkflowTests
{
// Tests complete workflows: import โ run โ verify โ export
}
```
### **PR Testing Requirements**
Before creating a PR, ensure:
```powershell
# Required - Integration tests pass (excludes VBA)
dotnet test --filter "Category=Integration&RunType!=OnDemand&Feature!=VBA&Feature!=VBATrust"
# Code builds without warnings
dotnet build -c Release
# Code follows style guidelines (automatic via EditorConfig)
```
**For Complex Features:**
- โ
Add integration tests for all Excel operations
- โ
Test round-trip persistence (create โ save โ reload โ verify)
- โ
Update documentation
- โ
No unit tests needed (see ADR-001-NO-UNIT-TESTS.md)
## ๐ **MCP Server Configuration Management**
### **CRITICAL: Keep server.json in Sync**
When modifying MCP Server functionality, **you must update** `src/ExcelMcp.McpServer/.mcp/server.json`:
#### **When to Update server.json:**
- โ
**Adding new MCP tools** - Add tool definition to `"tools"` array
- โ
**Modifying tool parameters** - Update `inputSchema` and `properties`
- โ
**Changing tool descriptions** - Update `description` fields
- โ
**Adding new capabilities** - Update `"capabilities"` section
- โ
**Changing requirements** - Update `"environment"."requirements"`
#### **server.json Synchronization Checklist:**
```powershell
# After making MCP Server code changes, verify:
# 1. Tool definitions match actual implementations
Compare-Object (Get-Content "src/ExcelMcp.McpServer/.mcp/server.json" | ConvertFrom-Json).tools (Get-ChildItem "src/ExcelMcp.McpServer/Tools/*.cs")
# 2. Build succeeds with updated configuration
dotnet build src/ExcelMcp.McpServer/ExcelMcp.McpServer.csproj
# 3. Test MCP server starts without errors
dnx Sbroenne.ExcelMcp.McpServer --yes
```
#### **server.json Structure:**
```json
{
"version": "2.0.0", // โ Updated by release workflow
"tools": [ // โ Must match Tools/*.cs implementations
{
"name": "excel_file", // โ Must match [McpServerTool] attribute
"description": "...", // โ Keep description accurate
"inputSchema": { // โ Must match method parameters
"properties": {
"action": { ... }, // โ Must match actual actions supported
"filePath": { ... } // โ Must match parameter types
}
}
}
]
}
```
#### **Common server.json Update Scenarios:**
1. **Adding New Tool:**
```csharp
// In Tools/NewTool.cs
[McpServerTool]
public async Task<string> NewTool(string action, string parameter)
```
```json
// Add to server.json tools array
{
"name": "excel_newtool",
"description": "New functionality description",
"inputSchema": { ... }
}
```
2. **Adding Action to Existing Tool:**
```csharp
// In existing tool method
case "new-action":
return HandleNewAction(parameter);
```
```json
// Update inputSchema properties.action enum
"action": {
"enum": ["list", "create", "new-action"] // โ Add new action
}
```
## ๏ฟฝ๐ **PR Template Checklist**
When creating a PR, verify:
- [ ] **Code builds** with zero warnings
- [ ] **All tests pass** (unit tests minimum)
- [ ] **New features have tests**
- [ ] **Documentation updated** (README, etc.)
- [ ] **MCP server.json updated** (if MCP Server changes) โ **NEW**
- [ ] **Breaking changes documented**
- [ ] **Follows existing code patterns**
- [ ] **Commit messages are clear**
## ๐ซ **What NOT to Do**
- โ **Don't commit directly to `main`**
- โ **Don't create releases without PRs**
- โ **Don't skip tests**
- โ **Don't ignore build warnings**
- โ **Don't update version numbers manually** (release workflow handles this)
## ๐ก **Tips for Good PRs**
### Commit Messages
```text
โ
Good: "Add PowerQuery batch refresh command with error handling"
โ Bad: "fix stuff"
```
### PR Titles
```text
โ
Good: "Add batch operations for Power Query refresh"
โ Bad: "Update code"
```
### PR Size
- **Keep PRs focused** - One feature/fix per PR
- **Break large changes** into smaller, reviewable chunks
- **Include tests and docs** in the same PR as the feature
## ๐ง **Local Development Setup**
```powershell
# Clone the repository
git clone https://github.com/sbroenne/mcp-server-excel.git
cd ExcelMcp
# Install dependencies
dotnet restore
# Run all tests
dotnet test
# Build release version
dotnet build -c Release
# Test the built executable
.\src\ExcelMcp.CLI\bin\Release\net10.0\excelcli.exe --version
```
## ๐ **Application Insights / Telemetry Setup**
ExcelMcp uses Azure Application Insights (Classic SDK with WorkerService integration) for anonymous usage telemetry and crash reporting. Telemetry is **opt-out** (enabled by default in release builds).
### **How It Works**
The Application Insights connection string is **embedded at build time** via MSBuild - there is no runtime environment variable lookup.
**Build-time flow:**
1. MSBuild reads `AppInsightsConnectionString` property (from `Directory.Build.props.user` or env var)
2. Generates `TelemetryConfig.g.cs` with the connection string as a `const string`
3. Compiled assembly contains the embedded connection string
### **What is Tracked**
- **Tool invocations**: Tool name, action, duration (ms), success/failure
- **Unhandled exceptions**: Exception type and redacted stack trace
- **User ID**: SHA256 hash of machine identity (anonymous, 16 chars)
- **Session ID**: Random GUID per process (8 chars)
### **What is NOT Tracked**
- File paths, file names, or file contents
- User identity, machine name, or IP address
- Excel data, formulas, or cell values
- Connection strings, credentials, or passwords
### **Sensitive Data Redaction**
All telemetry passes through `SensitiveDataRedactingProcessor` which removes:
- Windows file paths (`C:\Users\...` โ `[REDACTED_PATH]`)
- UNC paths (`\\server\share\...` โ `[REDACTED_PATH]`)
- Connection string secrets (`Password=...` โ `[REDACTED_CREDENTIAL]`)
- Email addresses โ `[REDACTED_EMAIL]`
### **Local Development with Telemetry**
To enable telemetry in local builds:
```powershell
# 1. Copy the template file
Copy-Item "Directory.Build.props.user.template" "Directory.Build.props.user"
# 2. Edit Directory.Build.props.user and add your connection string
# <AppInsightsConnectionString>InstrumentationKey=xxx;IngestionEndpoint=...</AppInsightsConnectionString>
# 3. Build - connection string is embedded at compile time
dotnet build src/ExcelMcp.McpServer/ExcelMcp.McpServer.csproj
# 4. Run - telemetry is automatically sent to Azure
dotnet run --project src/ExcelMcp.McpServer/ExcelMcp.McpServer.csproj
```
**Note:** `Directory.Build.props.user` is gitignored - your connection string won't be committed.
### **Local Development without Telemetry**
If you don't create `Directory.Build.props.user`, builds will have an empty connection string and telemetry will be disabled. This is the default for local development.
### **Azure Resources Setup (Maintainers Only)**
To deploy the Application Insights infrastructure:
```powershell
# 1. Login to Azure
az login
# 2. Deploy resources (creates RG, Log Analytics, App Insights)
.\infrastructure\azure\deploy-appinsights.ps1 -SubscriptionId "<your-subscription-id>"
# 3. Copy the connection string from output
# Output: "Connection String: InstrumentationKey=xxx;IngestionEndpoint=..."
```
### **GitHub Secret Configuration (Maintainers Only)**
After deploying Azure resources:
1. Go to GitHub repo โ **Settings** โ **Secrets and variables** โ **Actions**
2. Add new secret: `APPINSIGHTS_CONNECTION_STRING`
3. Paste the connection string from deployment output
The release workflow sets this as an environment variable, and MSBuild embeds it at build time.
### **Telemetry Architecture**
```text
Build Time:
MSBuild โ reads AppInsightsConnectionString โ generates TelemetryConfig.g.cs
Runtime:
MCP Tool Invocation
โ
โผ
ExcelMcpTelemetry.TrackToolInvocation()
โ (tracks: tool, action, duration, success)
โผ
SensitiveDataRedactingProcessor
โ (removes: paths, credentials, emails)
โผ
TelemetryClient โ Application Insights
```
### **Files Overview**
| File | Purpose |
|------|---------|
| `Telemetry/ExcelMcpTelemetry.cs` | Static helper for tracking events |
| `Telemetry/ExcelMcpTelemetryInitializer.cs` | Sets User.Id and Session.Id on telemetry |
| `Telemetry/SensitiveDataRedactingProcessor.cs` | Redacts PII before transmission |
| `Program.cs` | Application Insights WorkerService configuration |
| `ExcelMcp.McpServer.csproj` | MSBuild target that generates TelemetryConfig.g.cs |
| `Directory.Build.props.user.template` | Template for local dev connection string |
| `infrastructure/azure/appinsights.bicep` | Azure resource definitions |
| `infrastructure/azure/deploy-appinsights.ps1` | Deployment script |
## ๏ฟฝ **Trimming and Native AOT Compatibility**
### **Why Trimming Is Not Supported**
ExcelMcp **cannot be trimmed** due to fundamental architectural constraints of Excel COM automation. The IL trimmer removes unused code at publish time, but Excel COM interop requires dynamic code paths that the trimmer cannot statically analyze.
### **Technical Constraints**
**1. Runtime COM Activation**
```csharp
// This code CANNOT be trimmed - Excel type comes from Windows Registry at runtime
Type? excelType = Type.GetTypeFromProgID("Excel.Application");
dynamic excel = Activator.CreateInstance(excelType)!;
```
The trimmer cannot know:
- What types will be returned by `GetTypeFromProgID` (it's a Windows Registry lookup)
- What members will be called on the `dynamic` object
**2. Late-Bound COM Calls**
```csharp
// All Excel operations use dynamic dispatch - the trimmer can't trace these calls
dynamic workbook = excel.Workbooks.Open(filePath);
dynamic sheet = workbook.Worksheets.Item(1);
sheet.Range["A1"].Value2 = "Hello";
```
**3. Excel is External**
- Excel is not a .NET assembly - it's an out-of-process COM server
- The .NET runtime uses the Dynamic Language Runtime (DLR) for all Excel calls
- No static type information exists for the trimmer to analyze
### **What We DID Modernize**
While the Excel automation core cannot be trimmed, we modernized the OLE Message Filter to use .NET source-generated COM interop:
| Component | Before | After |
|-----------|--------|-------|
| `IOleMessageFilter` | `[ComImport]` | `[GeneratedComInterface]` |
| `OleMessageFilter` | `class` | `[GeneratedComClass]` partial class |
| `CoRegisterMessageFilter` | `[DllImport]` | `[LibraryImport]` |
**Benefits:**
- โ
Compile-time marshalling code generation
- โ
No runtime IL stub generation for the message filter
- โ
Better diagnostics and debugging
### **Suppressed Warnings**
The following warnings are suppressed in `Directory.Build.props` because they cannot be fixed:
| Warning | Reason |
|---------|--------|
| `IL2026` | Reflection/dynamic code incompatible with trimming |
| `IL3050` | Code incompatible with Native AOT |
| `CA1416` | Windows-only APIs (this is a Windows-only project) |
### **Can We Ever Support Trimming?**
**No**, unless one of these happens:
1. **Excel exposes a .NET API** - Microsoft would need to create a managed Excel SDK
2. **We abandon COM** - Would require a completely different architecture (file-based only, no live automation)
3. **Excel is replaced** - Use a different spreadsheet engine with .NET bindings
**The current architecture is the standard approach** for Excel automation in .NET and is used by thousands of applications. Trimming is simply not compatible with COM automation.
### **Alternatives for Smaller Binaries**
If deployment size is a concern:
- Use **framework-dependent** deployment (default) - smallest option (~15 MB)
- The .NET runtime is typically already installed on Windows machines with Excel
- Self-contained deployment is only needed for isolated environments
## ๏ฟฝ๐ **Need Help?**
- **Read the docs**: [Contributing Guide](CONTRIBUTING.md)
- **Ask questions**: Create a GitHub Issue with the `question` label
- **Report bugs**: Use the bug report template
---
**Remember: Every change, no matter how small, must go through a Pull Request!**
This ensures code quality, proper testing, and maintains the project's reliability for all users.
