alphaspec 0.1.0__tar.gz

alphaspec-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: ci
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ["3.10", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - run: pip install -e '.[dev]'
+      - run: pytest -q
+      - name: examples validate cleanly with --strict
+        run: alphaspec validate --strict examples/artifacts/*.json examples/scores/*.json

alphaspec-0.1.0/.github/workflows/pages.yml

@@ -0,0 +1,39 @@
+name: pages
+# Serves the schemas at their $id URLs: https://openalpha-dev.github.io/alphaspec/schema/0.1/<kind>.schema.json
+# One-time setup: repository Settings → Pages → Source: GitHub Actions.
+on:
+  push:
+    branches: [main]
+    paths: ["schema/**", "catalog/**", ".github/workflows/pages.yml"]
+  workflow_dispatch:
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+concurrency:
+  group: pages
+  cancel-in-progress: true
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: assemble site
+        run: |
+          mkdir -p _site
+          cp -r schema catalog _site/
+          {
+            echo '<!doctype html><meta charset="utf-8"><title>AlphaSpec schemas</title>'
+            echo '<h1>AlphaSpec</h1><p>Contract schemas and indicator catalog. Source: <a href="https://github.com/openalpha-dev/alphaspec">openalpha-dev/alphaspec</a></p><ul>'
+            for f in schema/*/*.json catalog/indicators.json; do echo "<li><a href=\"$f\">$f</a></li>"; done
+            echo '</ul>'
+          } > _site/index.html
+      - uses: actions/configure-pages@v5
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: _site
+      - id: deployment
+        uses: actions/deploy-pages@v4

alphaspec-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,36 @@
+name: release
+# Push a tag vX.Y.Z → test → build → publish to PyPI via Trusted Publishing (no API token stored).
+# One-time setup on pypi.org: add a "pending publisher" for project alphaspec pointing at this
+# repository, workflow release.yml, environment pypi.
+on:
+  push:
+    tags: ["v*"]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install -e '.[dev]' build
+      - run: pytest -q
+      - name: tag matches package version
+        run: test "v$(python -c 'import alphaspec; print(alphaspec.__version__)')" = "${GITHUB_REF_NAME}"
+      - run: python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

alphaspec-0.1.0/.gitignore

@@ -0,0 +1,7 @@
+.venv/
+__pycache__/
+*.egg-info/
+dist/
+build/
+.pytest_cache/
+.idea/

alphaspec-0.1.0/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+## 0.1.0 — 2026-10-09
+
+- Contract 0.1 drafts: `artifact`, `score`, `gate-result`, `evidence`, shared `common` definitions.
+- Indicator catalog generated from the reference runtime (core / ext.cn / ext.l2 / ext.data profiles).
+- Lint rules AS001–AS015 (artifact) and AS101–AS105 (score), each with a conformance case.
+- Python validator and `alphaspec` CLI.
+- Agent Skill in `skills/alphaspec`.
+- Runtime client (`alphaspec.Client`, standard library only) and CLI commands: `whoami`, `submit`, `evaluate`, `result`, `list`, `promote`.
+- `docs/RUNTIME_API.md`: the agent API a runtime exposes.
+- Indicator catalog now carries meaning: summary, parameter descriptions, unit, pitfalls, in Chinese and English (`catalog/i18n/en.json`, keyed by the Chinese text so a changed description fails the tests until it is re-translated). `catalog --lang en|zh`, MCP `lang`.
+- Reference commands so an installed Agent Skill needs no checkout: `catalog`, `schema`, `examples`, `docs`, `rules --explain`. Examples and docs ship inside the wheel.
+- Agent Skill rewritten to be self-contained (`pip install alphaspec` + the commands above).
+- RUNTIME_API: evaluation is one continuous backtest split into in-sample / out-of-sample segments; daily strategies use 4y + 1y; out-of-sample is judged relative to the market index.
+- gate-result checks carry `metric`, naming what `actual` measures; the CLI prints every check's hint, not only failing ones.
+- Reference runtime: `DONCHIAN_UPPER / MIDDLE / LOWER` now cover the N bars **before** the current one (turtle convention), so `close > DONCHIAN_UPPER` is a reachable breakout. Previously the band included the current bar and that condition could never hold.
+- Reference runtime: Deflated Sharpe pass line 0.95 → 0.90 (documented in RUNTIME_API with the Sharpe it implies per number of trials).
+- MCP server `alphaspec-mcp` (extra `alphaspec[mcp]`, stdio) exposing the offline reference tools and the runtime calls; no order tool.
+- `alphaspec skill [--install DIR]`: the Agent Skill ships in the wheel, so installing it needs no checkout.
+- Schema `$id` URLs: `https://openalpha-dev.github.io/alphaspec/schema/0.1/…`, served by GitHub Pages from this repository.

alphaspec-0.1.0/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.

alphaspec-0.1.0/PKG-INFO

@@ -0,0 +1,322 @@
+Metadata-Version: 2.5
+Name: alphaspec
+Version: 0.1.0
+Summary: The auditable contract between alpha and execution: JSON schemas, a validator and lint rules for declarative trading strategies.
+Project-URL: Homepage, https://github.com/openalpha-dev/alphaspec
+Project-URL: Documentation, https://github.com/openalpha-dev/alphaspec#readme
+Project-URL: Changelog, https://github.com/openalpha-dev/alphaspec/blob/main/CHANGELOG.md
+Project-URL: Schemas, https://openalpha-dev.github.io/alphaspec/schema/0.1/
+Author: OpenAlpha contributors
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ai-agent,backtest,dsl,json-schema,quant,strategy,trading
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Requires-Python: >=3.10
+Requires-Dist: jsonschema>=4.18
+Requires-Dist: referencing>=0.30
+Provides-Extra: dev
+Requires-Dist: mcp>=1.2; extra == 'dev'
+Requires-Dist: pytest>=7; extra == 'dev'
+Provides-Extra: mcp
+Requires-Dist: mcp>=1.2; extra == 'mcp'
+Description-Content-Type: text/markdown
+
+# AlphaSpec
+
+**A business language for trading strategies that humans, AI agents and execution systems can all read, check and agree on.**
+
+[中文说明](https://github.com/openalpha-dev/alphaspec/blob/main/README.zh-CN.md) ·
+[Spec](https://github.com/openalpha-dev/alphaspec/blob/main/docs/SPEC.md) ·
+[Lint rules](https://github.com/openalpha-dev/alphaspec/blob/main/docs/RULES.md) ·
+[Runtime API](https://github.com/openalpha-dev/alphaspec/blob/main/docs/RUNTIME_API.md) ·
+[Reference runtime: EasyQuant](https://www.goeasyquant.com)
+
+AlphaSpec is an open specification for handing a trading strategy, or a model's output, to an
+execution system. A strategy is a JSON document: indicators, entry and exit conditions, universe
+and risk settings. There is no code in it, so everything that matters can be checked before
+anything runs, by a validator, by a risk reviewer, or by the AI that wrote it.
+
+```bash
+pip install "alphaspec[mcp]"
+alphaspec validate my_strategy.json
+```
+
+## Why a strategy DSL, and why now
+
+> **The bottleneck of AI-driven research was never the model. It is the missing feedback loop: a
+> model never learns what its signals did in a real market.**
+
+**AI made writing strategies cheap. It did not make trusting them cheap.** An agent can produce a
+hundred candidate strategies in an afternoon. What it cannot do on its own is tell which of them
+survive look-ahead bias, multiple testing and real trading rules. The bottleneck has moved from
+*producing* ideas to *verifying* them, and verification needs something both sides can read.
+
+Generated code is the wrong medium for that. It is different every time, reveals what it does only
+when executed, needs a sandbox, and a risk desk cannot approve it line by line. A declarative
+document can be:
+
+- **validated on the spot** by a schema and semantic lint rules, with no sandbox;
+- **constrained at generation time**, so a model can only emit well-formed documents;
+- **diffed**: "the oversold threshold changed from 30 to 28" is a change a person can review;
+- **audited** field by field by a risk desk;
+- **free of injection surface**: there is nowhere to put code.
+
+That makes AlphaSpec a **business language between people and machines**. A person states an idea in
+plain words; an agent turns it into a document built from a shared vocabulary of indicators whose
+meaning, units and pitfalls are written down; the validator says exactly what is wrong and why; the
+runtime executes the same document the person reviewed. Every party is looking at the same thing.
+
+AlphaSpec is **not trying to replace Python**. Research in whatever you like: pandas, PyTorch,
+LightGBM, any agent framework. AlphaSpec is the boundary: what crosses into execution must be a
+document that can be checked, compared and audited.
+
+## What it defines
+
+Two ways in, written by you or your agent:
+
+| Level | Document | For | You send |
+|---|---|---|---|
+| **L1 · Score** | [`score`](https://github.com/openalpha-dev/alphaspec/blob/main/schema/0.1/score.schema.json) | ML teams, factor researchers | `(asOf, market, symbol, score)` or target weights |
+| **L2 · Artifact** | [`artifact`](https://github.com/openalpha-dev/alphaspec/blob/main/schema/0.1/artifact.schema.json) | rule-based strategies, AI agents | a rule tree with parameters, universe and risk overrides |
+
+Two ways back, written by the runtime and never by the submitter:
+
+| Document | What it answers |
+|---|---|
+| [`gate-result`](https://github.com/openalpha-dev/alphaspec/blob/main/schema/0.1/gate-result.schema.json) | Did it pass, judged on figures the runtime **recomputed itself**, check by check |
+| [`evidence`](https://github.com/openalpha-dev/alphaspec/blob/main/schema/0.1/evidence.schema.json) | What happened in a real market: rejections, slippage, fills, deviation from target, every number with its caliber |
+
+The way back is the point. Research tools see prices, news and filings; none of that says whether
+an order was rejected, how much slippage it paid, or how far the portfolio drifted from its target.
+Only an execution system knows, and only if it reports it in a form the research side can read.
+`gate-result` and `evidence` are that form: the feedback loop the model was missing.
+
+```mermaid
+flowchart LR
+    R["Your research<br/>Python · ML · AI agent"] -->|AlphaSpec document| V["alphaspec<br/>local validation"]
+    V -->|HTTPS · API key| E["Runtime<br/>backtest on windows it chooses"]
+    E --> G{"Gate"}
+    G -->|passed| P["Paper trading"]
+    P -.->|institutions| L["Live execution"]
+    G -.->|gate-result| R
+    P -.->|evidence| R
+```
+
+A short artifact:
+
+```json
+{
+  "contractVersion": "0.1",
+  "kind": "artifact",
+  "title": "RSI rebound above the 60-day average",
+  "market": "cn_stock",
+  "timeframe": "1d",
+  "dsl": {
+    "version": 1,
+    "params": { "oversold": 30 },
+    "indicators": {
+      "rsi":  { "type": "RSI", "period": 14 },
+      "ma60": { "type": "SMA", "period": 60 }
+    },
+    "entry": { "type": "AND",
+      "left":  { "type": "CROSS_UP", "left": { "ind": "rsi" },   "right": { "ref": "oversold" } },
+      "right": { "type": "GT",       "left": { "ind": "close" }, "right": { "ind": "ma60" } } },
+    "exit":  { "type": "GTE", "left": { "ind": "rsi" }, "right": { "const": 70 } }
+  },
+  "universe": { "mode": "SYMBOLS", "symbols": ["600519.SH", "000333.SZ"] },
+  "producer": { "kind": "AI_AGENT", "name": "my-agent@0.1", "searchTrials": 3 }
+}
+```
+
+`producer.searchTrials` is how many candidates the search tried, discarded ones included. The more
+you tried, the higher the bar the gate sets, so luck is not mistaken for skill.
+
+## How a submission runs today
+
+The reference runtime is **EasyQuant**. A submitted artifact goes through the same path a strategy
+built in its own UI does:
+
+1. **Validate twice.** Locally by `alphaspec`, then again by the runtime, which also compiles the
+   rule tree in its own engine.
+2. **Backtest on windows the runtime chooses.** One continuous backtest, reported as two segments:
+   for daily strategies the last 4 years in-sample and the most recent year out-of-sample; for
+   intraday strategies 18 months and 6 months. Returns are annualised on trading time; China's T+1,
+   price limits and lot sizes apply.
+3. **Gate, check by check.** In-sample return, drawdown and Sharpe; out-of-sample performance
+   **relative to the market index** over the same period; a Deflated Sharpe test that uses
+   `searchTrials`; structural look-ahead checks. Each check returns its metric, actual value,
+   threshold and a hint, so an agent can act on it instead of guessing.
+4. **Promote to paper trading.** A passing artifact becomes a paper-trading strategy in the
+   submitter's account, created disabled; the person starts it.
+5. **Go live, for institutions.** On the institutional edition the same strategy runs against
+   broker counters through the same risk checks and ledger, and execution evidence flows back.
+
+An API key can submit, evaluate, read results and promote. It cannot place orders or touch
+accounts. An agent passes through exactly the same door as a person.
+
+## About EasyQuant
+
+[EasyQuant](https://www.goeasyquant.com) is a quantitative strategy delivery platform: research,
+backtesting, paper trading and live execution on one engine, so the number you saw in a backtest is
+computed the same way as the order that reaches the market. It is built around four principles:
+**explainable** (every signal, rejection and fill carries a reason), **reproducible** (one engine for
+backtest, paper and live), **operable** (monitoring, alerting, reconciliation) and **extensible**
+(new markets, data sources and counters plug in behind stable interfaces).
+
+- **Markets**: China A-shares, ETFs and convertible bonds, futures and options, Hong Kong and US
+  equities, crypto spot.
+- **Execution**: broker and exchange counters such as CTP, XTP, QMT, PTrade, TORA and IBKR; pre-trade
+  risk checks on a single order path; a cash and position ledger reconciled against the broker.
+- **Research**: 220+ indicators and chart patterns with written semantics (the same catalog
+  AlphaSpec ships), factor research, visual rule canvas, stock pools, parameter scans with
+  out-of-sample validation.
+- **Built-in AI research**: describe what you want in plain words. *AI stock screening* turns
+  "low valuation, high dividend, no ST" into screening conditions you can adjust, shows the
+  candidates and why each was picked, and saves them as a stock pool. *AI strategy drafting* turns a
+  trading idea into entry, exit and risk rules, validates them, opens them on the visual canvas with
+  buy and sell points previewed, and from there into backtesting and paper trading. Nothing is saved
+  or run until you confirm.
+- **Two editions**: an institutional console for funds, brokerage quant desks and studios, including
+  live trading; and a [personal edition](https://trade.goeasyquant.com) with AI-assisted research,
+  backtesting and paper trading, where any user can create an AlphaSpec API key for free.
+
+### AI writes the same document you would
+
+A strategy drafted by EasyQuant's AI, one built by hand on its canvas, and one submitted as AlphaSpec by
+an outside agent are the **same kind of object**: a rule tree from the same indicator vocabulary,
+compiled by the same engine, backtested under the same rules and judged by the same gate. The AI does
+not produce a pile of code that differs every run and can only be proven right by running it. It
+produces a document you can read before it runs, change by hand, compare with the last version, and
+hand back to the AI to improve. That is what makes AI output something a person can take
+responsibility for.
+
+## An open ecosystem
+
+AlphaSpec lives under **[openalpha-dev](https://github.com/openalpha-dev)**, a family of open
+components around one idea: alpha should be easy to express, honest to evaluate and safe to execute.
+
+- **Any runtime can implement it.** A compliant runtime must pass every case in
+  [`conformance/cases`](https://github.com/openalpha-dev/alphaspec/tree/main/conformance/cases).
+  EasyQuant is the reference, not the gatekeeper.
+- **Any agent can use it.** The Agent Skill and MCP server work with Claude Code, Cursor, Codex and
+  any MCP client. EasyQuant's own AI research assistant uses the same public API and nothing more:
+  if it needed a private shortcut, the ecosystem would not be real.
+- **More components to come**, including **AlphaSpace**, a local research desk that brings your own
+  model, data and LLM key and submits through the same API, and pieces of the execution stack such as
+  risk checks, published as independent modules.
+
+## Getting started
+
+### Command line and Python
+
+```bash
+pip install alphaspec
+alphaspec examples                        # documents to start from
+alphaspec catalog --search breakout       # indicators, with meaning, parameters and pitfalls
+alphaspec validate my_strategy.json       # errors and warnings, each with a fix hint
+alphaspec rules --explain AS003           # why a rule exists
+```
+
+Submitting to a runtime (EasyQuant: create the key under *Account → API Keys*):
+
+```bash
+export ALPHASPEC_BASE_URL=https://trade.goeasyquant.com
+export ALPHASPEC_API_KEY=eqk_...
+
+alphaspec whoami
+alphaspec submit my_strategy.json --evaluate --promote
+```
+
+```python
+from alphaspec import Client
+
+c = Client()                       # reads ALPHASPEC_BASE_URL and ALPHASPEC_API_KEY
+aid = c.submit(doc)["artifactId"]  # validates locally first
+c.evaluate(aid)
+gate = c.wait(aid)
+if gate["passed"]:
+    c.promote(aid, name="my strategy")
+```
+
+### Agent Skill (agents that can run commands)
+
+```bash
+alphaspec skill --install ~/.claude/skills   # or your agent's skills directory
+```
+
+The skill teaches the agent the workflow: start from an example, look indicators up instead of
+guessing, validate until clean, report `searchTrials` honestly, never quote numbers the runtime did
+not return.
+
+### MCP (agents without a shell)
+
+```json
+{
+  "mcpServers": {
+    "alphaspec": {
+      "command": "alphaspec-mcp",
+      "env": {
+        "ALPHASPEC_BASE_URL": "https://trade.goeasyquant.com",
+        "ALPHASPEC_API_KEY": "eqk_..."
+      }
+    }
+  }
+}
+```
+
+The client speaks MCP to a local `alphaspec-mcp` process over stdio; that process calls the runtime
+over HTTPS with the same client as the CLI, so the key only ever goes to the runtime. Tools:
+`validate`, `explain_rule`, `search_indicators`, `get_indicator`, `get_schema`, `list_examples`,
+`get_example`, `get_doc` (offline) and `whoami`, `submit`, `evaluate`, `gate_result`,
+`list_submissions`, `promote` (runtime). There is no order tool.
+
+## Lint rules are where the experience lives
+
+Each rule in [docs/RULES.md](https://github.com/openalpha-dev/alphaspec/blob/main/docs/RULES.md)
+exists because a runtime once accepted that mistake, ran it, and produced wrong numbers without an
+error. Some examples:
+
+- **AS003**: a daily indicator read from the still-forming daily bar inside an intraday strategy.
+  In a backtest that bar already contains the close: look-ahead.
+- **AS001**: an indicator alias with a typo. The rule compiles to nothing and never fires.
+- **AS011**: `600000` instead of `600000.SH`. On venue-qualified markets the bare code is a
+  different series.
+- **AS012**: AI-generated output that does not report how many candidates were tried, which leaves
+  nothing to correct a multiple-testing-inflated Sharpe ratio with.
+
+The indicator catalog carries the same kind of knowledge: `close > DAY_HIGH` can never be true
+because the day's high includes the current bar; the catalog says so and points to
+`DAY_HIGH_BEFORE`.
+
+## Markets
+
+Market rules are scoped, not removed. Core indicators work on any market. Indicators that encode a
+market's own rules, such as China's daily price limits, belong to an extension profile and are
+rejected where those rules do not exist. See
+[docs/MARKETS.md](https://github.com/openalpha-dev/alphaspec/blob/main/docs/MARKETS.md).
+
+## Repository layout
+
+```
+schema/0.1/          JSON Schemas: the normative contract
+catalog/             indicator catalog with semantics (Chinese and English)
+conformance/cases/   accept/reject cases every compliant runtime must agree with
+examples/            documents that pass with zero issues
+src/alphaspec/       validator, CLI, runtime client, MCP server
+skills/alphaspec/    Agent Skill
+docs/                semantics, lint rules, markets, runtime API
+```
+
+## Versioning
+
+Every document carries `contractVersion`, so a runtime can refuse what it does not understand.
+Breaking changes bump the contract version. Schemas are published at their `$id` URLs, e.g.
+`https://openalpha-dev.github.io/alphaspec/schema/0.1/artifact.schema.json`.
+
+## License
+
+Apache-2.0