talyx-mcp 0.0.1__tar.gz

talyx_mcp-0.0.1/.github/workflows/ci.yaml

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e . --group dev
+
+      - name: Lint (ruff)
+        run: ruff check .
+
+      - name: Test (pytest)
+        run: pytest

talyx_mcp-0.0.1/.gitignore

@@ -0,0 +1,15 @@
+# Claude Code local settings
+.claude
+/CLAUDE.md
+
+# Python
+__pycache__/
+*.pyc
+.venv/
+*.egg-info/
+.pytest_cache/
+.ruff_cache/
+build/
+dist/
+
+docs/migration-2026-07-28.md

talyx_mcp-0.0.1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   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 [yyyy] [name of copyright owner]
+
+   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.

talyx_mcp-0.0.1/PKG-INFO

@@ -0,0 +1,157 @@
+Metadata-Version: 2.4
+Name: talyx-mcp
+Version: 0.0.1
+Summary: Prometheus exporter and alerting proxy for MCP servers
+Author: Tsung-Yao Chen
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: opentelemetry-exporter-prometheus>=0.65b0
+Requires-Dist: opentelemetry-sdk>=1.44
+Requires-Dist: prometheus-client>=0.20
+Provides-Extra: otlp
+Requires-Dist: opentelemetry-exporter-otlp-proto-http>=1.44; extra == 'otlp'
+Description-Content-Type: text/markdown
+
+# Talyx
+
+English | [繁體中文](README.zh-TW.md)
+
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+[![MCP Spec](https://img.shields.io/badge/MCP-2026--07--28-green.svg)](https://modelcontextprotocol.io)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+**Prometheus exporter and alerting for MCP servers.** When your MCP server breaks, your users just see a broken agent—you see exactly which server failed, how slow it got, and when. Wrap any stdio server, **zero code changes**.
+
+Talyx is a **zero-code proxy**: it sits between your MCP client and server,
+forwards the stdio JSON-RPC untouched, and exports Prometheus metrics about the
+traffic. It ships with a Grafana dashboard and Alertmanager rules. It is
+**stateless** — no database, Prometheus just scrapes `/metrics`.
+
+```mermaid
+flowchart LR
+    client["MCP client"] <-->|stdio JSON-RPC| talyx["talyx<br/>(proxy + exporter)"]
+    talyx <-->|stdio JSON-RPC| server["your MCP server"]
+    talyx -->|/metrics :9464| prom["Prometheus"] --> grafana["Grafana"]
+    prom --> am["Alertmanager"]
+```
+
+## Table of Contents
+
+- [Talyx](#talyx)
+  - [Table of Contents](#table-of-contents)
+  - [Quickstart (the demo)](#quickstart-the-demo)
+  - [Use it on your own server](#use-it-on-your-own-server)
+  - [Metrics](#metrics)
+  - [How it works](#how-it-works)
+  - [Roadmap](#roadmap)
+  - [License](#license)
+  - [Author](#author)
+
+## Quickstart (the demo)
+
+Runs talyx + a sample MCP server + Prometheus + Alertmanager + Grafana, with
+live traffic, in one command:
+
+```bash
+git clone https://github.com/alan66603/talyx.git
+cd talyx
+docker compose -f deploy/compose/demo.yaml up --build
+```
+
+Then open **http://localhost:3000** → dashboard **MCP Overview** (anonymous, no
+login). You'll see request rate, error rate, p95 latency, and the flagship
+**Multi Round-Trip** panels — elicitation loops, round-trips per request, and
+**abandoned cycles** (agents silently stuck waiting on a confirmation) — updating
+live. Prometheus is on `:9090`, Alertmanager on `:9093`.
+
+## Use it on your own server
+
+Point your MCP client at `talyx` instead of the server, and pass the real
+command after `--`:
+
+```jsonc
+// before
+{ "command": "npx", "args": ["-y", "@modelcontextprotocol/server-everything"] }
+
+// after — same server, now observed
+{ "command": "talyx", "args": ["--", "npx", "-y", "@modelcontextprotocol/server-everything"] }
+```
+
+Metrics are then at `http://localhost:9464/metrics`. Install with
+`pip install .` (or use the image at `deploy/docker/Dockerfile`). Configure the
+port with `TALYX_METRICS_PORT` / `TALYX_METRICS_HOST`. To also push metrics
+over OTLP, set `TALYX_OTLP_ENDPOINT` and install the extra:
+`pip install '.[otlp]'` (Prometheus `/metrics` stays on regardless).
+
+> The flagship cycle metrics need a server that speaks MCP `2026-07-28`
+> (`InputRequiredResult`). Wrapping an older server still gives you the core
+> reliability metrics; to see the cycle panels, try the bundled mock server:
+> `talyx -- python -m talyx.mock.server`.
+
+## Metrics
+
+Aligned to the MCP `2026-07-28` (stateless) spec. Full reference:
+[docs/metrics.md](docs/metrics.md).
+
+**Core reliability**
+
+| Metric | Type | Labels |
+|---|---|---|
+| `talyx_requests_total` | counter | `method`, `server`, `status` |
+| `talyx_request_duration_seconds` | histogram | `method`, `server` |
+| `talyx_errors_total` | counter | `method`, `server`, `error_code` |
+
+**Multi Round-Trip cycles — the flagship.** In MCP's latest version, `2026-07-28` server can answer a
+`tools/call` with an `InputRequiredResult` and the client re-sends with the
+server's `requestState`; that elicitation loop is one *logical* request that
+generic APM reads as two unrelated ones.
+
+| Metric | Type | Labels |
+|---|---|---|
+| `talyx_input_required_total` | counter | `method`, `server`, `wait_type` |
+| `talyx_round_trips_per_request` | histogram | `wait_type` |
+| `talyx_round_trip_cycle_duration_seconds` | histogram | `wait_type` |
+| `talyx_input_wait_duration_seconds` | histogram | `server`, `wait_type` |
+| `talyx_abandoned_cycles_total` | counter | `server`, `wait_type` |
+| `talyx_request_state_rejected_total` | counter | `server` |
+
+Plus basic liveness (`talyx_server_up`, `talyx_inflight_requests_lost_total`) and
+`talyx_proxy_overhead_seconds`.
+
+**`talyx_abandoned_cycles_total`** counts cycles where the server sent an
+`InputRequired` but got no follow-up. No error, no timeout, which can be overlooked. A single count means little (users pause or walk away), but a spike
+above baseline usually signals a broken or confusing prompt, especially around
+high-risk `InputRequiredResult` gates.
+
+**Security:** Talyx records *no tool arguments* and no message bodies — only
+method/tool names, outcomes, and timings. The one correlation key it needs (the
+sealed `requestState` token) is **hashed in memory and never stored** See [docs/metrics.md](docs/metrics.md).
+
+**Overhead:** talyx's own per-chunk processing is sub-millisecond
+(`talyx_proxy_overhead_seconds`), so it doesn't meaningfully slow the server down.
+
+## How it works
+
+The proxy forwards bytes in both directions untouched and observes the
+JSON-RPC as a side-channel — if observation ever fails, forwarding is
+unaffected. It's stateless by design, which is the core difference from
+trace-based tools. See [docs/architecture.md](docs/architecture.md)
+for the positioning table and the "why a proxy, not an SDK" rationale.
+
+## Roadmap
+
+Optional OTLP **metrics** export already ships (`TALYX_OTLP_ENDPOINT`), and
+the proxy forwards W3C `traceparent` untouched. Still ahead: OTLP **trace/span**
+export (to your own Tempo/Jaeger), HTTP transport + OAuth, a Helm chart, and
+optional body capture. Token usage isn't visible in MCP protocol traffic, so
+Talyx does not claim token metrics.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).
+
+## Author
+
+[![LinkedIn](https://img.shields.io/badge/LinkedIn-Connect-0A66C2?logo=linkedin)](https://www.linkedin.com/in/tsung-yao-chen-75481718b)

talyx_mcp-0.0.1/README.md

@@ -0,0 +1,142 @@
+# Talyx
+
+English | [繁體中文](README.zh-TW.md)
+
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+[![MCP Spec](https://img.shields.io/badge/MCP-2026--07--28-green.svg)](https://modelcontextprotocol.io)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+**Prometheus exporter and alerting for MCP servers.** When your MCP server breaks, your users just see a broken agent—you see exactly which server failed, how slow it got, and when. Wrap any stdio server, **zero code changes**.
+
+Talyx is a **zero-code proxy**: it sits between your MCP client and server,
+forwards the stdio JSON-RPC untouched, and exports Prometheus metrics about the
+traffic. It ships with a Grafana dashboard and Alertmanager rules. It is
+**stateless** — no database, Prometheus just scrapes `/metrics`.
+
+```mermaid
+flowchart LR
+    client["MCP client"] <-->|stdio JSON-RPC| talyx["talyx<br/>(proxy + exporter)"]
+    talyx <-->|stdio JSON-RPC| server["your MCP server"]
+    talyx -->|/metrics :9464| prom["Prometheus"] --> grafana["Grafana"]
+    prom --> am["Alertmanager"]
+```
+
+## Table of Contents
+
+- [Talyx](#talyx)
+  - [Table of Contents](#table-of-contents)
+  - [Quickstart (the demo)](#quickstart-the-demo)
+  - [Use it on your own server](#use-it-on-your-own-server)
+  - [Metrics](#metrics)
+  - [How it works](#how-it-works)
+  - [Roadmap](#roadmap)
+  - [License](#license)
+  - [Author](#author)
+
+## Quickstart (the demo)
+
+Runs talyx + a sample MCP server + Prometheus + Alertmanager + Grafana, with
+live traffic, in one command:
+
+```bash
+git clone https://github.com/alan66603/talyx.git
+cd talyx
+docker compose -f deploy/compose/demo.yaml up --build
+```
+
+Then open **http://localhost:3000** → dashboard **MCP Overview** (anonymous, no
+login). You'll see request rate, error rate, p95 latency, and the flagship
+**Multi Round-Trip** panels — elicitation loops, round-trips per request, and
+**abandoned cycles** (agents silently stuck waiting on a confirmation) — updating
+live. Prometheus is on `:9090`, Alertmanager on `:9093`.
+
+## Use it on your own server
+
+Point your MCP client at `talyx` instead of the server, and pass the real
+command after `--`:
+
+```jsonc
+// before
+{ "command": "npx", "args": ["-y", "@modelcontextprotocol/server-everything"] }
+
+// after — same server, now observed
+{ "command": "talyx", "args": ["--", "npx", "-y", "@modelcontextprotocol/server-everything"] }
+```
+
+Metrics are then at `http://localhost:9464/metrics`. Install with
+`pip install .` (or use the image at `deploy/docker/Dockerfile`). Configure the
+port with `TALYX_METRICS_PORT` / `TALYX_METRICS_HOST`. To also push metrics
+over OTLP, set `TALYX_OTLP_ENDPOINT` and install the extra:
+`pip install '.[otlp]'` (Prometheus `/metrics` stays on regardless).
+
+> The flagship cycle metrics need a server that speaks MCP `2026-07-28`
+> (`InputRequiredResult`). Wrapping an older server still gives you the core
+> reliability metrics; to see the cycle panels, try the bundled mock server:
+> `talyx -- python -m talyx.mock.server`.
+
+## Metrics
+
+Aligned to the MCP `2026-07-28` (stateless) spec. Full reference:
+[docs/metrics.md](docs/metrics.md).
+
+**Core reliability**
+
+| Metric | Type | Labels |
+|---|---|---|
+| `talyx_requests_total` | counter | `method`, `server`, `status` |
+| `talyx_request_duration_seconds` | histogram | `method`, `server` |
+| `talyx_errors_total` | counter | `method`, `server`, `error_code` |
+
+**Multi Round-Trip cycles — the flagship.** In MCP's latest version, `2026-07-28` server can answer a
+`tools/call` with an `InputRequiredResult` and the client re-sends with the
+server's `requestState`; that elicitation loop is one *logical* request that
+generic APM reads as two unrelated ones.
+
+| Metric | Type | Labels |
+|---|---|---|
+| `talyx_input_required_total` | counter | `method`, `server`, `wait_type` |
+| `talyx_round_trips_per_request` | histogram | `wait_type` |
+| `talyx_round_trip_cycle_duration_seconds` | histogram | `wait_type` |
+| `talyx_input_wait_duration_seconds` | histogram | `server`, `wait_type` |
+| `talyx_abandoned_cycles_total` | counter | `server`, `wait_type` |
+| `talyx_request_state_rejected_total` | counter | `server` |
+
+Plus basic liveness (`talyx_server_up`, `talyx_inflight_requests_lost_total`) and
+`talyx_proxy_overhead_seconds`.
+
+**`talyx_abandoned_cycles_total`** counts cycles where the server sent an
+`InputRequired` but got no follow-up. No error, no timeout, which can be overlooked. A single count means little (users pause or walk away), but a spike
+above baseline usually signals a broken or confusing prompt, especially around
+high-risk `InputRequiredResult` gates.
+
+**Security:** Talyx records *no tool arguments* and no message bodies — only
+method/tool names, outcomes, and timings. The one correlation key it needs (the
+sealed `requestState` token) is **hashed in memory and never stored** See [docs/metrics.md](docs/metrics.md).
+
+**Overhead:** talyx's own per-chunk processing is sub-millisecond
+(`talyx_proxy_overhead_seconds`), so it doesn't meaningfully slow the server down.
+
+## How it works
+
+The proxy forwards bytes in both directions untouched and observes the
+JSON-RPC as a side-channel — if observation ever fails, forwarding is
+unaffected. It's stateless by design, which is the core difference from
+trace-based tools. See [docs/architecture.md](docs/architecture.md)
+for the positioning table and the "why a proxy, not an SDK" rationale.
+
+## Roadmap
+
+Optional OTLP **metrics** export already ships (`TALYX_OTLP_ENDPOINT`), and
+the proxy forwards W3C `traceparent` untouched. Still ahead: OTLP **trace/span**
+export (to your own Tempo/Jaeger), HTTP transport + OAuth, a Helm chart, and
+optional body capture. Token usage isn't visible in MCP protocol traffic, so
+Talyx does not claim token metrics.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).
+
+## Author
+
+[![LinkedIn](https://img.shields.io/badge/LinkedIn-Connect-0A66C2?logo=linkedin)](https://www.linkedin.com/in/tsung-yao-chen-75481718b)

talyx_mcp-0.0.1/README.zh-TW.md

@@ -0,0 +1,133 @@
+# Talyx
+
+[English](README.md) | 繁體中文
+
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+[![MCP Spec](https://img.shields.io/badge/MCP-2026--07--28-green.svg)](https://modelcontextprotocol.io)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+**給 MCP server 用的 Prometheus 匯出器與告警工具。** 把它包在任何 stdio MCP server
+外面，**不必改一行程式碼**，就能在 server 壞掉或變慢的當下馬上知道，且讓你可以確切知道壞掉的地方。
+
+Talyx 是一個 zero-code proxy：它坐在你的 MCP client 與 server 之間，原封不動地轉發
+stdio JSON-RPC，並把流量的 Prometheus 指標匯出。內附一組 Grafana dashboard 與
+Alertmanager 規則。它是 **stateless** 的——沒有資料庫，Prometheus 直接抓 `/metrics`。
+
+```mermaid
+flowchart LR
+    client["MCP client"] <-->|stdio JSON-RPC| talyx["talyx<br/>(proxy + exporter)"]
+    talyx <-->|stdio JSON-RPC| server["your MCP server"]
+    talyx -->|/metrics :9464| prom["Prometheus"] --> grafana["Grafana"]
+    prom --> am["Alertmanager"]
+```
+
+## 目錄
+
+- [Talyx](#talyx)
+  - [目錄](#目錄)
+  - [Quick Start](#quick-start)
+  - [如何用在你自己的 server](#如何用在你自己的-server)
+  - [指標](#指標)
+  - [運作方式](#運作方式)
+  - [Roadmap](#roadmap)
+  - [License](#license)
+  - [作者](#作者)
+
+## Quick Start
+
+一行指令跑起 talyx + 一個範例 MCP server + Prometheus + Alertmanager + Grafana，
+外加即時流量：
+
+```bash
+git clone https://github.com/alan66603/talyx.git
+cd talyx
+docker compose -f deploy/compose/demo.yaml up --build
+```
+
+接著打開 **http://localhost:3000** → dashboard **MCP Overview**（匿名，免登入）。
+你會看到 request rate、error rate、p95 latency，以及招牌的 **Multi Round-Trip** 面板
+——elicitation 循環、每個請求的往返次數，還有 **abandoned cycles**（agent 靜默卡在
+等一個永遠不來的確認）——全部即時更新。Prometheus 在 `:9090`，Alertmanager 在 `:9093`。
+
+## 如何用在你自己的 server
+
+把你的 MCP client 指向 `talyx`（而不是 server），真正的指令放在 `--` 後面：
+
+```jsonc
+// 改之前
+{ "command": "npx", "args": ["-y", "@modelcontextprotocol/server-everything"] }
+
+// 改之後——同一個 server，現在被觀測了
+{ "command": "talyx", "args": ["--", "npx", "-y", "@modelcontextprotocol/server-everything"] }
+```
+
+指標就會在 `http://localhost:9464/metrics`。用 `pip install .` 安裝（或用
+`deploy/docker/Dockerfile` 的映像）。用 `TALYX_METRICS_PORT` / `TALYX_METRICS_HOST`
+設定埠號。若還想把指標推到 OTLP，設 `TALYX_OTLP_ENDPOINT` 並裝上額外相依：
+`pip install '.[otlp]'`（Prometheus `/metrics` 一律照常開著）。
+
+> 招牌的循環指標需要一個講 MCP `2026-07-28`（會回 `InputRequiredResult`）的 server。
+> 包在舊 server 上仍能拿到核心可靠性指標；想看循環面板，可以用內附的 mock server：
+> `talyx -- python -m talyx.mock.server`。
+
+## 指標
+
+對齊 MCP `2026-07-28`（stateless）規格。完整參考：[docs/metrics.zh-TW.md](docs/metrics.zh-TW.md)。
+
+**核心可靠性**
+
+| 指標 | 型別 | Labels |
+|---|---|---|
+| `talyx_requests_total` | counter | `method`、`server`、`status` |
+| `talyx_request_duration_seconds` | histogram | `method`、`server` |
+| `talyx_errors_total` | counter | `method`、`server`、`error_code` |
+
+**Multi Round-Trip 循環** MCP `2026-07-28` 版本更新後，server 可以用
+`InputRequiredResult` 回應 `tools/call`，client 再帶著 server 的 `requestState` 重送；
+這個 elicitation 循環是**一個**邏輯請求，但通用 APM 會把它讀成兩個不相干的請求。
+
+| 指標 | 型別 | Labels |
+|---|---|---|
+| `talyx_input_required_total` | counter | `method`、`server`、`wait_type` |
+| `talyx_round_trips_per_request` | histogram | `wait_type` |
+| `talyx_round_trip_cycle_duration_seconds` | histogram | `wait_type` |
+| `talyx_input_wait_duration_seconds` | histogram | `server`、`wait_type` |
+| `talyx_abandoned_cycles_total` | counter | `server`、`wait_type` |
+| `talyx_request_state_rejected_total` | counter | `server` |
+
+另有基礎 liveness（`talyx_server_up`、`talyx_inflight_requests_lost_total`）與
+`talyx_proxy_overhead_seconds`。
+
+**`talyx_abandoned_cycles_total`** 記錄 server 發出 `InputRequired` 卻沒等到
+回覆的循環。這在新版本不算 error 也沒有 timeout, 因此是容易被忽略的行爲。單次計數並無代表性(使用者可能
+只是離開)，但比率異常升高可能表示提示壞了或令人困惑，在高風險的
+`InputRequiredResult` 把關處值得參考。
+
+**隱私與安全：** Talyx **不記錄任何 tool 參數**、不記錄訊息內容，只取 method/tool
+名稱、結果與時間。它唯一需要的關聯鍵（密封的 `requestState` token）**在記憶體內雜湊、
+絕不落地**。詳見 [docs/metrics.zh-TW.md](docs/metrics.zh-TW.md)。
+
+**額外開銷：** talyx 自身每個 chunk 的處理是次毫秒等級（`talyx_proxy_overhead_seconds`），
+所以不會實質拖慢 server。
+
+## 運作方式
+
+proxy 在兩個方向都原封轉發位元組，把 JSON-RPC 當旁路（side-channel）觀測——就算觀測
+失敗，轉發也不受影響。它天生 stateless，這是與 trace 類工具的核心
+差異。
+
+## Roadmap
+
+可選的 OTLP **metrics** 匯出已經有了（`TALYX_OTLP_ENDPOINT`），proxy 也會原封轉發
+W3C `traceparent`。還在路上：OTLP **trace/span** 匯出（推到你自己的 Tempo/Jaeger）、
+HTTP transport + OAuth、Helm chart，以及可選的 body capture。token 用量在 MCP 協定
+流量中看不到，所以 Talyx 刻意不宣稱 token 指標。
+
+## License
+
+Apache-2.0。見 [LICENSE](LICENSE)。
+
+## 作者
+
+[![LinkedIn](https://img.shields.io/badge/LinkedIn-Connect-0A66C2?logo=linkedin)](https://www.linkedin.com/in/tsung-yao-chen-75481718b)