Skip to main content
Glama
SmartyJohnway

TW-Market Live Data Intelligence

README.md
# TW-Market Live Data Intelligence

[English](README.md) | [繁體中文](README.zh-TW.md)

> Local-first, governed Taiwan-market evidence for an operator and an AI
> assistant — validate first, preview bounded work, then explicitly authorize
> one execution where the capability permits it.

![Deterministic Unified Workbench overview](docs/assets/workbench-overview.png)

ProductVersion = `1.0.0`. The current stable release is `v1.0.0`
([GitHub Release](https://github.com/SmartyJohnway/tw-market-live-data-intelligence/releases/tag/v1.0.0)).
The published prerelease history is `v1.0.0-rc.1`
([GitHub Release](https://github.com/SmartyJohnway/tw-market-live-data-intelligence/releases/tag/v1.0.0-rc.1)),
and the earlier stable GitHub Release was `v0.1.0`. Phase G has not started.
This is a local-first evidence workbench, not a realtime trading product.

## Why TW-Market

AI discussion needs evidence with identity, source, timestamp, caveat, and
execution provenance — not an unqualified price claim. This workbench gives a
human operator a governed local path from request validation to an AI-ready
handoff, while retaining a separate audit package.

## Quick start

```bash
git clone https://github.com/SmartyJohnway/tw-market-live-data-intelligence.git
cd tw-market-live-data-intelligence
python -m venv .venv
# Activate .venv using your shell, then:
python -m pip install -r requirements-lock.txt
python scripts/verify_environment.py
python scripts/manage_security_master.py status
```

`NOT_INITIALIZED` is the normal fresh-install state. A Security Master update
is an explicit operator action and may use official external acquisition:

```bash
python scripts/manage_security_master.py update --live
python scripts/run_unified_workbench.py
```

Open the loopback Workbench at [`/workbench/`](http://127.0.0.1:8000/workbench/).
For an MCP host, start the separate stdio launcher:

```bash
python scripts/run_unified_market_evidence_mcp.py
```

## A governed 2330 workflow

1. Create or select an installation-local Watchlist, then add `2330`.
2. Compose a Unified Market Evidence Request and validate its identity.
3. Preview the planned operation and its capability boundary.
4. Explicitly authorize and confirm one bounded execution only when the
   preview is executable.
5. Read the canonical Result and Audit Package, or export the AI-ready
   handoff for continued discussion.

## Core capabilities

- **Identity-aware requests:** Mode A validates targets against the
  installation-local Taiwan Market Identity Service.
- **Bounded execution:** Mode B previews, explicitly authorizes, and executes
  one request only when its governed capability is executable.
- **Auditable handoff:** Mode C creates a canonical Result, separate Audit
  Package, and AI-ready Markdown without dispatching another market source.
- **Persistent Watchlists are supported:** installation-local Watchlists have immutable
  revisions, optimistic concurrency, and explicit preview/commit mutation.

## Unified MCP

The MCP surface has exactly six governed tools:

`market_describe_capabilities`, `market_validate_request`,
`market_preview_request`, `market_read_result`,
`market_export_ai_handoff`, and `market_fetch_evidence`.

See the [V1 public contracts](docs/contracts/V1_PUBLIC_CONTRACTS.md) and
[current AI usage guide](docs/agent_usage_guide.md) for request, result, and
handoff semantics.

## MCP distribution

The supported Windows MCPB distribution is published with
[`v1.0.0`](https://github.com/SmartyJohnway/tw-market-live-data-intelligence/releases/tag/v1.0.0):
[download the MCPB](https://github.com/SmartyJohnway/tw-market-live-data-intelligence/releases/download/v1.0.0/tw-market-unified-mcp-v1.0.0-win-x64.mcpb)
and its [SHA-256 sidecar](https://github.com/SmartyJohnway/tw-market-live-data-intelligence/releases/download/v1.0.0/tw-market-unified-mcp-v1.0.0-win-x64.mcpb.sha256).
It uses local stdio transport and provides the same six tools. The [official
Registry entry](https://registry.modelcontextprotocol.io/v0.1/servers?search=io.github.SmartyJohnway/tw-market-live-data-intelligence)
is `io.github.SmartyJohnway/tw-market-live-data-intelligence`. See
[MCP distribution](docs/distribution/MCP_DISTRIBUTION.md) for installation
scope, integrity, and Security Master boundaries.

## Data and source caveats

Capability support, currentness, source provenance, and execution eligibility
are explicit product data. A supported identity does not imply an executable
source route; a preview is not an authorization; a source observation is not a
realtime guarantee. Consult the [capability matrix](docs/reference/CAPABILITY_MATRIX.md),
[source matrix](docs/reference/SOURCE_MATRIX.md), and
[governance boundaries](docs/reference/GOVERNANCE_BOUNDARIES.md) before relying
on any result.

## Safety and non-goals

There is no automatic polling, scheduler, startup market fetch, Watchlist-driven
automatic execution, trading, order routing, full-market scan, model-selected
URL/executor, or realtime guarantee. Persistent Watchlists mutate only through
explicit preview/commit. Never commit credentials, tokens, cookies, or private
market payloads.

## Documentation

- [Operator quick start](docs/operator/QUICK_START.md)
- [Local Workbench guide](docs/operator/LOCAL_WORKBENCH.md)
- [Troubleshooting](docs/operator/TROUBLESHOOTING.md)
- [Documentation index](docs/INDEX.md)
- [V1 release](docs/release/V1_RELEASE.md)
- [Changelog](CHANGELOG.md)

## Contributing and security

Read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request. Report
security concerns using the grounded guidance in [SECURITY.md](SECURITY.md).

## Release status

`VERSION` records `1.0.0`. The current stable release is `v1.0.0`
([GitHub Release](https://github.com/SmartyJohnway/tw-market-live-data-intelligence/releases/tag/v1.0.0));
published prerelease history remains `v1.0.0-rc.1`, and Phase G has **not
started**. Both release tags are immutable authorities; subsequent documentation
status updates do not move them.

## Project Overview

This root README is the current product entry point. Engineering history,
protocol acceptance, and prior M5/M6/M8 architecture remain available through
[Project History](docs/PROJECT_HISTORY.md), the [Engineering history / protocol
archive](docs/INDEX.md#engineering-history--protocol-archive), and
[`docs/archive/`](docs/archive/), including the
[`2026-06-30 historical README`](docs/archive/readme/README_20260630_M5LRM_ARCHITECTURE_CONVERGENCE.md).
They are retained for audit and compatibility,
not as a second current-product contract.

## License

See [LICENSE](LICENSE).

TDQS

B3.2/5.0

Scored across 6 tools

Disambiguation4/5

Each tool has a distinct role in the workflow: describe, validate, preview, read, export, and fetch. However, validate_request and preview_request both operate on a canonical request and could be confused, though their descriptions clarify that one validates and the other builds a preview.

Naming Consistency4/5

All tools use a consistent market_ prefix followed by a verb and noun (e.g., describe_capabilities, validate_request, preview_request). The pattern is mostly uniform, though market_export_ai_handoff and market_fetch_evidence are slightly longer and less parallel than the others.

Tool Count5/5

Six tools is a well-scoped set for a market intelligence server. Each tool covers a distinct stage in the evidence lifecycle without redundancy or bloat.

Completeness4/5

The tool set covers the full workflow from capability discovery through validation, preview, execution, result reading, and export. A minor gap is the lack of an explicit execute tool, though market_fetch_evidence appears to handle execution-triggered retrieval.

Maintenance

ActivityActive
ResponsivenessNo issues