@tokcalc/mcp-server 0.1.1 → 0.1.3

package/CONTRIBUTING.md

@@ -0,0 +1,177 @@
+# Contributing to tokcalc
+
+First of all — **thank you** for considering a contribution. tokcalc is a community-maintained capacity planner and every contribution makes the LLM serving ecosystem more transparent.
+
+This document explains how to add models, GPUs, quantization formats, and benchmark data. The bar for acceptance is **source-cited, defensible data** — not vibes.
+
+## Code of conduct
+
+Be kind. Be precise. Disclose provenance. Don't market. Don't fabricate.
+
+## Quick ways to contribute
+
+| Contribution | Difficulty | Where to look |
+|---|---|---|
+| Add a missing model | Easy | `src/lib/token-calc.ts` → `MODELS` array |
+| Add a missing GPU | Easy | `src/lib/token-calc.ts` → `GPUS` array |
+| Add a quantization format | Easy | `src/lib/token-calc.ts` → `QUANTIZATIONS` array |
+| Fix a typo / UI bug | Trivial | Anywhere in `src/app/page.tsx` |
+| Improve a formula | Hard | `calculate()` in `src/lib/token-calc.ts` |
+| Submit a benchmark | Medium | Open an issue with the schema below |
+
+## How to add a model
+
+Add a row to the `MODELS` array in [`src/lib/token-calc.ts`](src/lib/token-calc.ts). The schema:
+
+```typescript
+{
+  id: "llama3-15b",                    // unique, lowercase, no spaces
+  name: "Llama 3.2 15B",               // human-readable, includes variant
+  family: "Llama",                     // for dropdown grouping
+  category: "text",                    // "text" | "vlm" | "embedding" | "code" | "reasoning"
+  paramsB: 15.0,                       // TOTAL params in billions (e.g., 671 for DeepSeek V3 MoE)
+  activeParamsB: 15.0,                // ACTIVE params per token (for MoE; = paramsB for dense)
+  layers: 64,                          // num_hidden_layers from config.json
+  hiddenDim: 5120,                     // hidden_size from config.json
+  qHeads: 40,                          // num_attention_heads
+  kvHeads: 8,                          // num_key_value_heads (for GQA)
+  headDim: 128,                        // head_dim (or hidden_size / num_attention_heads)
+  vocabSize: 128256,                   // vocab_size
+  maxContext: 131072,                  // max_position_embeddings
+  isMoE: false,                        // true if Mixture-of-Experts
+}
+```
+
+### Source requirements (mandatory)
+- **Architecture fields** (`layers`, `hiddenDim`, `qHeads`, `kvHeads`, `headDim`, `vocabSize`, `maxContext`) MUST come from the model's `config.json` on HuggingFace — not from blog posts or third-party summaries.
+- **Total/active params** for MoE models MUST come from the official release announcement or model card.
+- Add a comment with the source URL:
+  ```typescript
+  // Refs: https://huggingface.co/meta-llama/Llama-3.2-15B
+  ```
+
+### Don't fabricate
+- If a field isn't published (e.g., DeepSeek V3's exact architecture), **leave it as a placeholder and add a TODO comment**, or omit the entry entirely. Don't guess.
+- For announced-but-unreleased models (e.g., Llama 4 Behemoth), mark the row with `// announced — not yet released` and only add if there's an official model card or config.
+
+## How to add a GPU
+
+Add a row to the `GPUS` array. The schema:
+
+```typescript
+{
+  id: "rtx-5090",
+  name: "RTX 5090 32GB",
+  vendor: "NVIDIA",                    // "NVIDIA" | "AMD" | "Intel" | "Google" | "Apple" | "Groq" | "Cerebras" | ...
+  category: "consumer",               // "datacenter" | "workstation" | "consumer" | "mac" | "tpu" | "lpu" | "wse" | "legacy"
+  memBandwidthGbps: 1792,             // HBM/unified memory bandwidth in GB/s
+  flopsTflops: 105,                   // FP16/BF16 dense TFLOPS. Use `null` if vendor doesn't publish (e.g., B200)
+  vramGb: 32,                         // VRAM in GB
+  nvlinkGbps: 0,                      // 0 if no NVLink
+  usdPerHour: 0.50,                   // Typical cloud $/hr; `null` if quote-only
+  year: 2025,                         // Release year
+  note: "Optional note about caveats", // e.g., "ROCm; performance depends on ROCm version"
+  sourceUrl: "https://www.nvidia.com/en-us/geforce/graphics-cards/50-series",
+}
+```
+
+### Critical guardrails (per research brief)
+- **Never use FP4/FP8/sparse FLOPS as FP16 dense**. NVIDIA Blackwell B200/B300 only publishes FP4/FP8 specs — set `flopsTflops: null` and add a note. The calc engine handles this gracefully with a conservative fallback.
+- **Apple Silicon unified memory ≠ GPU VRAM**. Bandwidth figures are accurate but thermal behavior differs. Always include a `note` for Apple.
+- **Cloud $/hr is approximate + region-specific**. Use `null` for "quote required". Add a comment with the source URL.
+
+## How to add a quantization format
+
+Add a row to the `QUANTIZATIONS` array. The schema:
+
+```typescript
+{
+  id: "gguf-q4km",
+  label: "GGUF Q4_K_M",
+  bytesPerParam: 0.55,                 // EFFECTIVE bytes per param (averaged across tensor mix)
+  efficiency: 0.90,                   // Dequant overhead multiplier. 1.0 = no overhead, 0.85 = 15% slower
+                                       // >1.0 means FASTER than FP16 (e.g., FP8 on H100 = 1.5)
+  description: "Recommended sweet spot for local Llama/Mistral on consumer GPUs.",
+  family: "gguf",                      // "float" | "gguf" | "gptq" | "awq" | "exl2" | "fp8" | "nvfp4"
+  useCase: "Recommended for local inference",  // Optional
+}
+```
+
+### Source requirements
+- For GGUF variants, use measured file sizes from the [llama.cpp quantize README](https://github.com/ggml-org/llama.cpp/blob/master/tools/quantize/README.md) or from actual `.gguf` files on HuggingFace.
+- For `efficiency`, cite a benchmark source if possible. Don't invent numbers.
+
+## How to submit a benchmark
+
+We're building a benchmark provenance database. To submit a benchmark, open an issue with this template:
+
+```markdown
+**Model:** DeepSeek V3 671B (MoE)
+**Quantization:** FP8
+**GPU:** 8× H100 SXM5 80GB
+**Engine:** vLLM v0.29.0
+**Configuration:** `--max-num-seqs=256 --max-num-batched-tokens=8192 --tensor-parallel-size=8`
+**Workload:**
+- Input distribution: 4096 mean / 95th percentile 8192 tokens
+- Output: 512 mean / 95th percentile 1024 tokens
+- Concurrency: 256
+- QPS: 18
+
+**Measured:**
+- Throughput (output tok/s, aggregate): 412
+- TTFT p50: 220 ms
+- TTFT p95: 580 ms
+- ITL p50: 24 ms
+- ITL p95: 38 ms
+
+**Source URL:** https://github.com/vllm-project/vllm/issues/12345
+**Methodology:** vLLM `benchmark_serving.py` with 1000 requests
+**Date:** 2026-09-21
+**Submitter:** @yourhandle
+```
+
+### Confidence tiers
+1. **Tier 1**: Official vLLM/SGLang/TensorRT-LLM benchmarks, MLPerf submissions
+2. **Tier 2**: Reproducible benchmark runs (you ran it yourself with documented config)
+3. **Tier 3**: Community observations (less rigorous, clearly labeled)
+
+All three are accepted, but they're displayed differently in the UI.
+
+## How to improve a formula
+
+The math lives in `calculate()` in `src/lib/token-calc.ts`. Every formula has a comment citing the source.
+
+When improving a formula:
+1. Open an issue first describing the problem + proposed fix
+2. Cite the source (paper, blog, official docs)
+3. Don't introduce "magic numbers" without justification
+4. Update the comments to reflect the new source
+5. Test against benchmark data if available
+
+## Development setup
+
+```bash
+git clone https://github.com/tokcalc/tokcalc.git
+cd tokcalc
+bun install
+bun run dev
+```
+
+Open `http://localhost:3000`. Make changes. Verify with `bun run lint`.
+
+## PR checklist
+
+Before opening a PR:
+- [ ] `bun run lint` passes (warnings OK, errors not)
+- [ ] All new model/GPU/quant entries have a source URL in a comment
+- [ ] No fabricated data — leave `null` for unknown fields
+- [ ] UI changes verified in both light and dark mode
+- [ ] Description explains **why**, not just **what**
+- [ ] No marketing language ("revolutionary", "the first ever", etc.)
+- [ ] No console.log statements left behind
+
+## License
+
+By contributing, you agree that your contributions are licensed under the Apache 2.0 license (see [LICENSE](LICENSE)).
+
+For benchmark data contributions, you agree they'll be licensed under CC-BY-SA 4.0 (attribution + share-alike) — this protects the community's data investment.

package/Caddyfile

@@ -0,0 +1,23 @@
+:81 {
+	@transform_port_query {
+		query XTransformPort=*
+	}
+
+	handle @transform_port_query {
+		reverse_proxy localhost:{query.XTransformPort} {
+			header_up Host {host}
+			header_up X-Forwarded-For {remote_host}
+			header_up X-Forwarded-Proto {scheme}
+			header_up X-Real-IP {remote_host}
+		}
+	}
+
+	handle {
+		reverse_proxy localhost:3000 {
+			header_up Host {host}
+			header_up X-Forwarded-For {remote_host}
+			header_up X-Forwarded-Proto {scheme}
+			header_up X-Real-IP {remote_host}
+		}
+	}
+}

package/LICENSE

@@ -0,0 +1,204 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file. For the avoidance of
+      doubt, the "tokcalc" name and logo are trademarks of the project
+      maintainers and may not be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 tokcalc
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied. See the License for the specific language governing permissions
+   and limitations under the License.