Skip to content

docs(bitnet): drop the ANcpLua.NET.Sdk.BitNet section from README #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
github-actions merged 3 commits into from
May 18, 2026
Merged

docs(bitnet): drop the ANcpLua.NET.Sdk.BitNet section from README #102

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d495f6
docs(bitnet): drop the ANcpLua.NET.Sdk.BitNet zero-ceremony section
ANcpLua May 18, 2026
179ec37
docs(bitnet): add Install section after dropping SDK variant path
ANcpLua May 18, 2026
ef27752
Merge branch 'main' into claude/remove-bitnet-sdk-variant-XuaCv
ANcpLua May 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 14 additions & 23 deletions src/ANcpLua.Agents.Hosting.BitNet/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,20 @@ Alpha-channel package. Keep isolated from stable/preview consumers unless explic
- Tested against: Microsoft.Agents.AI 1.4.0 + Microsoft.Extensions.AI 10.5.x
- Capability tested against: BitNet b1.58 2B-4T weights served by Microsoft's prebuilt `bitnet.cpp` Docker image

## Install

```sh
dotnet add package ANcpLua.Agents.Hosting.BitNet
```

Or add the `PackageReference` by hand:

```xml
<PackageReference Include="ANcpLua.Agents.Hosting.BitNet" />
```

Under Central Package Management (recommended; required by `ANcpLua.NET.Sdk`), pin the version in your `Directory.Packages.props` and leave the `Version=` off the `PackageReference` itself.

## Standing up a BitNet server

The hosting package only speaks HTTP to an OpenAI-compatible endpoint — it never builds, downloads, or spawns the binary. You can satisfy that contract any way you like; Microsoft's prebuilt Docker image is the easiest path:
Expand Down Expand Up @@ -57,29 +71,6 @@ LM Studio, vLLM with a BitNet build, a private inference gateway, your own fork

Stock `Microsoft.Extensions.AI.OpenAI` works against any OpenAI-compatible endpoint — but `llama-server` builds older than [ggml-org/llama.cpp#19831](https://github.com/ggml-org/llama.cpp/pull/19831) (merged 2026-02-23) silently ignore the SDK-emitted `max_completion_tokens` field and generate to the context limit. This package promotes the `LegacyMaxTokensPolicy` shim out of test-only territory and ships it as part of the runtime path. Once Microsoft's BitNet fork picks up the upstream merge, the policy becomes a no-op self-deleting decorator.

## Zero-ceremony path — `ANcpLua.NET.Sdk.BitNet`

If your repo already uses an MSBuild SDK from [ANcpLua/ANcpLua.NET.Sdk](https://github.com/ANcpLua/ANcpLua.NET.Sdk), switch the variant from `.Web` to `.BitNet` and you get this hosting package as an implicit `PackageReference` — no `<PackageReference Include="ANcpLua.Agents.Hosting.BitNet" />` line of your own needed. The pinned version lives in the SDK's `Version.props` and ships in lockstep with releases here.

```json
// global.json
{ "msbuild-sdks": { "ANcpLua.NET.Sdk.BitNet": "3.4.31" } }
```

```xml
<!-- consumer .csproj -->
<Project Sdk="ANcpLua.NET.Sdk.BitNet">
<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<NoWarn>$(NoWarn);ANCPLBITNET001</NoWarn>
</PropertyGroup>
</Project>
```

**Hard requirement — Central Package Management.** The SDK forces `ManagePackageVersionsCentrally=true` and the enforcement target errors if the consumer overrides it. Ship a `Directory.Packages.props` at or above the consumer (an empty one with `<ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>` is enough); without it, restore fails with `NU1015` on the SDK-injected analyzers.

Then call `builder.AddQylBitNetChatClient()` in `Program.cs` exactly as below.

## Usage — four modes
Copy link
Copy Markdown

@codacy-production codacy-production Bot May 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 MEDIUM RISK

Suggestion: The documentation no longer explains how to install or reference the ANcpLua.Agents.Hosting.BitNet package. Since the 'Zero-ceremony path' is removed, users need a standard way to add the dependency. Try running the following prompt in your coding agent: > Add an 'Installation' section to src/ANcpLua.Agents.Hosting.BitNet/README.md before the 'Usage' section showing how to add the package using 'dotnet add package ANcpLua.Agents.Hosting.BitNet'.


### Mode 0 — zero config (defaults to `BITNET_URL`)
Expand Down
Loading