Integration tests for the GroupDocs.Metadata.Mcp
NuGet package — an MCP server that exposes
GroupDocs.Metadata as AI-callable tools.
This repository validates the published NuGet artifact end-to-end: it
launches the server via dnx, connects as an MCP client, and exercises every
advertised tool. It also doubles as a copy-pasteable set of example configs
and user-facing how-to guides for every deployment channel.
- how-to/ — step-by-step guides for every deployment channel (NuGet, Docker, MCP registry, Claude Desktop, VS Code / Copilot, running the tests).
- examples/ — ready-to-paste
claude-desktop.json,vscode-mcp.json, anddocker-compose.yml. - AGENTS.md — orientation for AI coding agents working in this repo.
- llms.txt — machine-readable summary for LLM tooling.
- changelog/ — one entry per change set (see changelog/README.md for format).
| Area | Covered by |
|---|---|
Package installs and starts via dnx |
McpServerFixture |
| MCP handshake, server info, version | ToolDiscoveryTests |
ReadMetadata — PDF + JPEG, schema + values |
ReadMetadataTests |
RemoveMetadata — output file + read-back check |
RemoveMetadataTests |
| Unknown / corrupted files, password parameter | ErrorHandlingTests |
Requires .NET 10 SDK.
dotnet testTest a specific published version:
dotnet test -p:McpPackageVersion=26.4.4
# or
MCP_PACKAGE_VERSION=26.4.4 dotnet testThe first run downloads the NuGet package — subsequent runs are cached.
.github/workflows/integration.yml runs on:
- Every push / PR.
- Nightly cron — catches regressions in nuget.org, the dnx shim, or the .NET runtime.
workflow_dispatchwith apackage_versioninput — manual smoke of any version.repository_dispatch(nuget-published) — fires from the main repo's publish pipeline so every release is smoke-tested against live nuget.org. See Release smoke hook.
Matrix: ubuntu-latest, windows-latest, macos-latest.
To auto-verify each release, add this step to the main repo's publish workflow
after the dotnet nuget push step:
- name: Dispatch smoke tests
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
gh api repos/groupdocs-metadata/GroupDocs.Metadata.Mcp.Tests/dispatches \
-f event_type=nuget-published \
-f 'client_payload[package_version]=${{ steps.version.outputs.version }}'GroupDocs.Metadata refuses to Save() any file in evaluation mode — so
RemoveMetadata always returns an error unless a license is configured.
Tests branch on GROUPDOCS_LICENSE_PATH:
- Unset (default):
RemoveMetadata_InEvaluationMode_ReturnsErrorResponseruns and verifies the tool fails gracefully. Licensed-mode tests no-op. - Set: Licensed tests run — they assert the cleaned file is produced and
is re-readable by
ReadMetadata.
For CI, store a base64-encoded .lic file as repo secret GROUPDOCS_LICENSE
— the workflow decodes it into $RUNNER_TEMP and exports
GROUPDOCS_LICENSE_PATH automatically.
Sample documents are built from byte-arrays in SampleDocuments.cs at test startup — no binary files are checked into this repo.
To add a real-world fixture, drop it into sample-docs/ and write
a test that references it by filename. The project auto-copies everything in
sample-docs/ to the test output.
Copy configs from examples/:
- claude-desktop.json — Claude Desktop MCP server config.
- vscode-mcp.json — VS Code / GitHub Copilot.
- docker-compose.yml — containerized deployment.
MIT — see LICENSE.