Skip to main content
Version: 3.x

Using these docs with AI

These docs are built to be consumed by AI coding assistants, not just humans. There are three ways to plug them in.

1. llms.txt (zero setup)​

Every build publishes machine-readable bundles following the llmstxt.org standard:

FileContents
/llms.txtIndex of every doc section with links
/llms-full.txtAll documentation in one file
/llms-pipelines.txtPipelines, validation, error handling
/llms-outbox.txtEvents, outbox, observability

Paste a URL into any assistant, or let tools that understand llms.txt fetch them automatically. Pull a focused bundle when you only need one concern.

2. Context7 MCP (live, always current)​

Context7 indexes these docs and serves them over MCP, so an assistant can query them on demand without you pasting anything.

Library ID: /UnambitiousFx/Synapse

Claude Code​

claude mcp add --transport http context7 https://mcp.context7.com/mcp

Then ask: "use context7 — how do I register a pipeline behavior in Synapse?"

Cursor / VS Code​

Add Context7 as an MCP server (https://mcp.context7.com/mcp) in your editor's MCP settings, then reference the /UnambitiousFx/Synapse library in prompts.

tip

Several unrelated projects are named "Synapse" on Context7. Always use the fully-qualified ID /UnambitiousFx/Synapse to get these docs.

3. Agent skills shipped in the packages​

The NuGet packages ship Agent Skills: SKILL.md files that tell coding agents how to use the library correctly.

PackageSkill
UnambitiousFx.Synapseunambitiousfx-synapse
UnambitiousFx.Synapse.AspNetCoreunambitiousfx-synapse-aspnetcore

dotnet restore places them under ~/.nuget/packages/<id>/<version>/skills/, but agents only load skills from their own folders. Set UnambitiousFxSkillsDestination to have the packages copy their skills there on every build:

Directory.Build.props
<Project>
<PropertyGroup>
<UnambitiousFxSkillsDestination>$(MSBuildThisFileDirectory).claude/skills</UnambitiousFxSkillsDestination>
</PropertyGroup>
</Project>
AgentDestination
Claude Code.claude/skills
GitHub Copilot.github/skills
Codex and others, dotnet-package-skills.agents/skills
  • Opt-in. Nothing is written unless the property is set.
  • Always current. The copy runs on build (unchanged files are skipped), so a package update also updates the skill. A skill removed or renamed in a newer version is not deleted from the destination.
  • Transitive. Skills come from every referenced UnambitiousFx package, including ones pulled in by another package (for example UnambitiousFx.Functional 2.2.0 and later).
  • Never breaks the build. A failed copy (read-only or locked destination) is logged as warnings (MSB3021, MSB3026, MSB3027). If you build with -warnaserror / MSBuildTreatWarningsAsErrors, add MSB3021;MSB3026;MSB3027 to MSBuildWarningsNotAsErrors to keep them warnings.

Since the folder is regenerated on build, you can add it to .gitignore; commit it instead if agents should have the skills in a fresh clone before the first build.