diff --git a/MCP_SERVER.md b/MCP_SERVER.md index 675defb..4b1f468 100644 --- a/MCP_SERVER.md +++ b/MCP_SERVER.md @@ -2,7 +2,7 @@ [English overview](README.md) · [中文说明](README_zh-CN.md) · [SOC guide](docs/integrations/soc-reference.md) · [Guard guide](docs/integrations/agent-guard-onboarding.en.md) -OpenWorkProof exposes **32 local MCP tools in version 1.6.0**. Connect them to an existing Agent when you want to inspect signed work records, review supplied security alerts, or check an exported evidence bundle. +OpenWorkProof exposes **32 local MCP tools in version 1.6.1**. Connect them to an existing Agent when you want to inspect signed work records, review supplied security alerts, or check an exported evidence bundle. You can start with the synthetic alert example below without creating signing keys or connecting a production system. Developers integrating a work-contract workflow can then use the schema, signing, execution and verification tools. @@ -27,7 +27,7 @@ For a client that accepts an `mcpServers` configuration, add: "mcpServers": { "openworkproof": { "command": "uvx", - "args": ["--from", "openworkproof==1.6.0", "owp-mcp"] + "args": ["--from", "openworkproof==1.6.1", "owp-mcp"] } } } @@ -42,7 +42,7 @@ The configuration location and JSON shape depend on the host. For example, VS Co If you prefer to install the command first: ```sh -uv tool install 'openworkproof==1.6.0' +uv tool install 'openworkproof==1.6.1' ``` Then configure the MCP client to launch `owp-mcp`, using its absolute executable path if the client's environment cannot find it. An equivalent entry point in an environment where the package is installed is: @@ -51,7 +51,7 @@ Then configure the MCP client to launch `owp-mcp`, using its absolute executable python -m openworkproof.mcp_transport ``` -`uvx openworkproof==1.6.0` also starts the MCP server. The explicit `owp-mcp` entry point avoids confusing it with `owp`, which is the separate CLI. A manually started stdio server waits for MCP messages; it does not open a web page or a network port. +`uvx openworkproof==1.6.1` also starts the MCP server. The explicit `owp-mcp` entry point avoids confusing it with `owp`, which is the separate CLI. A manually started stdio server waits for MCP messages; it does not open a web page or a network port. ## 2. Try one complete alert-review example diff --git a/README.md b/README.md index ccf640d..c28e77c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ -**English** · [简体中文](README_zh-CN.md) +**English** · [简体中文](https://github.com/dengyier/OpenWorkProof/blob/main/README_zh-CN.md) **Check what an AI agent was allowed to do, what it recorded, and whether its evidence holds up.** @@ -12,16 +12,16 @@ You keep the final decision to accept or reject the result. Connecting OWP to an [Get started](#get-started-with-mcp) · [Codex Guard](#try-codex-preview-protection) · [Docs](#documentation) · [Community](#community-and-contributing) -Current release: **1.6.0** · [PyPI](https://pypi.org/project/openworkproof/1.6.0/) · [Release notes](https://github.com/dengyier/OpenWorkProof/releases/tag/v1.6.0) · [MCP Registry](https://registry.modelcontextprotocol.io/v0.1/servers/io.github.dengyier%2FOpenWorkProof/versions/1.6.0) +Current release: **1.6.1** · [PyPI](https://pypi.org/project/openworkproof/1.6.1/) · [Release notes](https://github.com/dengyier/OpenWorkProof/releases/tag/v1.6.1) · [MCP Registry](https://registry.modelcontextprotocol.io/v0.1/servers/io.github.dengyier%2FOpenWorkProof/versions/1.6.1) ## What can you do with it? | Your task | What OWP helps you do | Start here | | --- | --- | --- | -| Review an agent's work records | Check signed task scope, recorded actions and evidence; export a bundle another reviewer can inspect. Your integration must supply the records. | [MCP tools](MCP_SERVER.md), [offline verification](docs/offline-verification.md) | -| Let Codex edit a preview copy | Explicitly allow supported text edits inside one preview directory and reject out-of-scope requests in the guarded launch path. | [Guard setup](docs/integrations/agent-guard-onboarding.en.md) — experimental | -| Review Slips alert data | Group supplied JSONL alerts into review cases, inspect simulated decisions and export a signed evidence bundle. | [SOC walkthrough](docs/integrations/soc-reference.md) — reference implementation | -| Add evidence review to a delivery workflow | Integrate verification into a GitHub Action or your own agent workflow, then keep human acceptance as a separate step. | [GitHub Action example](examples/github-action/README.md), [integration details](docs/reference/project-overview-en.md#integration-paths) | +| Review an agent's work records | Check signed task scope, recorded actions and evidence; export a bundle another reviewer can inspect. Your integration must supply the records. | [MCP tools](https://github.com/dengyier/OpenWorkProof/blob/main/MCP_SERVER.md), [offline verification](https://github.com/dengyier/OpenWorkProof/blob/main/docs/offline-verification.md) | +| Let Codex edit a preview copy | Explicitly allow supported text edits inside one preview directory and reject out-of-scope requests in the guarded launch path. | [Guard setup](https://github.com/dengyier/OpenWorkProof/blob/main/docs/integrations/agent-guard-onboarding.en.md) — experimental | +| Review Slips alert data | Group supplied JSONL alerts into review cases, inspect simulated decisions and export a signed evidence bundle. | [SOC walkthrough](https://github.com/dengyier/OpenWorkProof/blob/main/docs/integrations/soc-reference.md) — reference implementation | +| Add evidence review to a delivery workflow | Integrate verification into a GitHub Action or your own agent workflow, then keep human acceptance as a separate step. | [GitHub Action example](https://github.com/dengyier/OpenWorkProof/blob/main/examples/github-action/README.md), [integration details](https://github.com/dengyier/OpenWorkProof/blob/main/docs/reference/project-overview-en.md#integration-paths) | OWP does not automatically watch every agent or tool on your computer. Fleet permissions, WorkBuddy integration and live SOC remediation are not part of the verified release paths above. @@ -34,13 +34,13 @@ You need Python **3.10+**, [uv](https://docs.astral.sh/uv/getting-started/instal "mcpServers": { "openworkproof": { "command": "uvx", - "args": ["openworkproof==1.6.0"] + "args": ["openworkproof==1.6.1"] } } } ``` -This is the common `mcpServers` configuration shape. Some clients use a different file or top-level key; see the [client-specific setup](MCP_SERVER.md). `uvx` downloads the package and dependencies when needed. OWP does not require an OWP cloud account or API key. +This is the common `mcpServers` configuration shape. Some clients use a different file or top-level key; see the [client-specific setup](https://github.com/dengyier/OpenWorkProof/blob/main/MCP_SERVER.md). `uvx` downloads the package and dependencies when needed. OWP does not require an OWP cloud account or API key. After the client connects, it should discover **32 tools**. Try this first with the included synthetic data: @@ -48,7 +48,7 @@ After the client connects, it should discover **32 tools**. Try this first with You should receive a case summary and evidence bundle. **`UNKNOWN` is expected without independent trust information**; it does not mean installation failed. This sample uses a deterministic investigation stub and simulated actions. It does not test detection accuracy or remediate a host. -To use your own alerts, follow the [SOC guide](docs/integrations/soc-reference.md). Alert content is returned to your MCP client and can enter its model conversation, so use data you are authorized to share with that client. +To use your own alerts, follow the [SOC guide](https://github.com/dengyier/OpenWorkProof/blob/main/docs/integrations/soc-reference.md). Alert content is returned to your MCP client and can enter its model conversation, so use data you are authorized to share with that client. ### Optional: install the SOC Review Skill @@ -58,7 +58,7 @@ The Skill gives your agent a repeatable procedure for using those tools. With No npx skills add dengyier/OpenWorkProof --skill openworkproof-soc-review ``` -Choose your agent and install scope in the installer. [Read the instructions first](skills/openworkproof-soc-review/SKILL.md), or use the [release ZIP](https://github.com/dengyier/OpenWorkProof/releases/download/v1.6.0/openworkproof-soc-review-1.6.0.zip). +Choose your agent and install scope in the installer. [Read the instructions first](https://github.com/dengyier/OpenWorkProof/blob/main/skills/openworkproof-soc-review/SKILL.md), or use the [release ZIP](https://github.com/dengyier/OpenWorkProof/releases/download/v1.6.0/openworkproof-soc-review-1.6.0.zip). The Skill does not configure MCP or enable Guard. Configure the MCP server above separately. Your client's usual model charges still apply. @@ -66,16 +66,16 @@ The Skill does not configure MCP or enable Guard. Configure the MCP server above **Experimental, separately enabled.** Guard is for supported local text-editing tasks in a designated preview directory. Use a new test project or a copy you own first. -Read the [English first-run guide](docs/integrations/agent-guard-onboarding.en.md) before enabling. It includes a complete test project, scope review, expected checks and uninstall steps. The approval prompts are currently in Chinese, while the default output is JSON. Review the scope yourself and enter `yes` only when you understand it; do not use a trust shortcut to skip that review. +Read the [English first-run guide](https://github.com/dengyier/OpenWorkProof/blob/main/docs/integrations/agent-guard-onboarding.en.md) before enabling. It includes a complete test project, scope review, expected checks and uninstall steps. The approval prompts are currently in Chinese, while the default output is JSON. Review the scope yourself and enter `yes` only when you understand it; do not use a trust shortcut to skip that review. `enable` runs a live probe and `run` uses your existing Codex login and model allowance. Continue only after `doctor` confirms the required setup, current review and live probe. Ordinary Codex launches are not automatically protected. -The recorded live-host baseline covers **macOS, Python 3.12 and Codex CLI 0.147.0**, from the Guard implementation introduced in 1.5.0. Check compatibility and rerun the probe in your own environment. Builds, deployment, online search, personal MCP/plugins and whole-computer isolation are outside this launch path. See [scope and limitations](docs/integrations/agent-guard-codex.md). +The recorded live-host baseline covers **macOS, Python 3.12 and Codex CLI 0.147.0**, from the Guard implementation introduced in 1.5.0. Check compatibility and rerun the probe in your own environment. Builds, deployment, online search, personal MCP/plugins and whole-computer isolation are outside this launch path. See [scope and limitations](https://github.com/dengyier/OpenWorkProof/blob/main/docs/integrations/agent-guard-codex.md). Install the CLI package, then run these commands from your target Git project after creating a `preview` directory and a text file such as `preview/index.html`: ```sh -uv tool install --python 3.12 'openworkproof==1.6.0' +uv tool install --python 3.12 'openworkproof==1.6.1' owp-guard install --project "$(pwd -P)" --allow-dir preview owp-guard enable --project "$(pwd -P)" owp-guard doctor --project "$(pwd -P)" @@ -97,12 +97,12 @@ owp acceptance-bundle-verify /path/to/acceptance-bundle owp-aisoc verify /path/to/soc-review ``` -These formats and their trust requirements differ. Follow the [Core verification guide](docs/offline-verification.md) or [SOC trust guide](docs/integrations/soc-reference.md#cli-and-independent-verification). Obtain expected public keys and checkpoints through a separate trusted route; copying them from an untrusted bundle does not establish who you are trusting. +These formats and their trust requirements differ. Follow the [Core verification guide](https://github.com/dengyier/OpenWorkProof/blob/main/docs/offline-verification.md) or [SOC trust guide](https://github.com/dengyier/OpenWorkProof/blob/main/docs/integrations/soc-reference.md#cli-and-independent-verification). Obtain expected public keys and checkpoints through a separate trusted route; copying them from an untrusted bundle does not establish who you are trusting. ## What a result means - **Verification checks evidence under the stated scope and trust inputs.** It does not establish that a business outcome is correct. Core `VERIFIED` and binding `BOUND` do not mean customer acceptance or payment. -- **Human acceptance is separate.** The intended reviewer keeps the decision to accept or reject a delivery. See the [acceptance workflow](docs/reference/project-overview-en.md#verification-and-acceptance-are-separate-decisions). +- **Human acceptance is separate.** The intended reviewer keeps the decision to accept or reject a delivery. See the [acceptance workflow](https://github.com/dengyier/OpenWorkProof/blob/main/docs/reference/project-overview-en.md#verification-and-acceptance-are-separate-decisions). - **SOC results are reference results.** Investigation is a deterministic stub; actions and acceptance statuses are simulated. There is no live SOC deployment, production detection benchmark, OS isolation or HSM in this integration. - **Signing tools can handle sensitive keys.** Generic key-generation/signing tools can return or accept private-key material. Keep production signing keys out of model conversations and use an externally controlled signing workflow. @@ -112,12 +112,12 @@ OWP is open source. The current package and Skill are free to use under their li | Need | Documentation | | --- | --- | -| Connect MCP and understand the 32 tools | [MCP setup and tool reference](MCP_SERVER.md) | -| Review Slips alerts and install the Skill | [SOC walkthrough](docs/integrations/soc-reference.md) | -| Set up a guarded Codex task | [English guide](docs/integrations/agent-guard-onboarding.en.md) · [中文指南](docs/integrations/agent-guard-onboarding.md) | -| Build an integration with signed task scope and human authority | [Human Agency protocol](docs/protocol/human-agency-profile-v0.1.md) · [runnable example](examples/human_agency_profile_v01.py) | -| Understand protocol mechanics and historical validation | [English reference](docs/reference/project-overview-en.md) · [中文参考](docs/reference/project-overview-zh-CN.md) · [status](docs/status.md) | -| Report a reproducible problem or contribute | [Contributing](CONTRIBUTING.md) · [Issues](https://github.com/dengyier/OpenWorkProof/issues) | +| Connect MCP and understand the 32 tools | [MCP setup and tool reference](https://github.com/dengyier/OpenWorkProof/blob/main/MCP_SERVER.md) | +| Review Slips alerts and install the Skill | [SOC walkthrough](https://github.com/dengyier/OpenWorkProof/blob/main/docs/integrations/soc-reference.md) | +| Set up a guarded Codex task | [English guide](https://github.com/dengyier/OpenWorkProof/blob/main/docs/integrations/agent-guard-onboarding.en.md) · [中文指南](https://github.com/dengyier/OpenWorkProof/blob/main/docs/integrations/agent-guard-onboarding.md) | +| Build an integration with signed task scope and human authority | [Human Agency protocol](https://github.com/dengyier/OpenWorkProof/blob/main/docs/protocol/human-agency-profile-v0.1.md) · [runnable example](https://github.com/dengyier/OpenWorkProof/blob/main/examples/human_agency_profile_v01.py) | +| Understand protocol mechanics and historical validation | [English reference](https://github.com/dengyier/OpenWorkProof/blob/main/docs/reference/project-overview-en.md) · [中文参考](https://github.com/dengyier/OpenWorkProof/blob/main/docs/reference/project-overview-zh-CN.md) · [status](https://github.com/dengyier/OpenWorkProof/blob/main/docs/status.md) | +| Report a reproducible problem or contribute | [Contributing](https://github.com/dengyier/OpenWorkProof/blob/main/CONTRIBUTING.md) · [Issues](https://github.com/dengyier/OpenWorkProof/issues) | ## Community and contributing @@ -125,10 +125,10 @@ OWP is open source. The current package and Skill are free to use under their li The card is a live directory badge; follow it for the scanned version and scope. Find OWP on [MCPRush](https://mcprush.com/dengyier/openworkproof-mcp), [Glama](https://glama.ai/mcp/servers/dengyier/OpenWorkProof), and [AgentSkills.in](https://www.agentskills.in/marketplace/@dengyier/openworkproof-soc-review). -The [community record](docs/reference/project-overview-en.md#community-contributions-and-external-records) preserves directory contributions, external research, integration experiments and technical writing, with their original links and checked dates. These records have different scopes and do not imply endorsement or production adoption. +The [community record](https://github.com/dengyier/OpenWorkProof/blob/main/docs/reference/project-overview-en.md#community-contributions-and-external-records) preserves directory contributions, external research, integration experiments and technical writing, with their original links and checked dates. These records have different scopes and do not imply endorsement or production adoption. Contribute a reproducible bug report, an integration, or a documentation improvement. Please report security issues privately through [GitHub Security Advisories](https://github.com/dengyier/OpenWorkProof/security/advisories/new). ## License -OWP Core: [Apache-2.0](LICENSE). Tim / alphatin123's contributed `aisoc` component: [MIT](LICENSES/MIT-aisoc.txt). The combined package metadata uses `Apache-2.0 AND MIT`. +OWP Core: [Apache-2.0](https://github.com/dengyier/OpenWorkProof/blob/main/LICENSE). Tim / alphatin123's contributed `aisoc` component: [MIT](https://github.com/dengyier/OpenWorkProof/blob/main/LICENSES/MIT-aisoc.txt). The combined package metadata uses `Apache-2.0 AND MIT`. diff --git a/README_zh-CN.md b/README_zh-CN.md index 04e30f2..8ead063 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -10,7 +10,7 @@ OpenWorkProof(OWP)是一套面向 Agent 开发者和团队的开源工具。 [开始使用](#通过-mcp-开始使用) · [Codex 目录保护](#试用-codex-预览目录保护) · [文档](#文档入口) · [社区](#社区与参与) -当前版本:**1.6.0** · [PyPI](https://pypi.org/project/openworkproof/1.6.0/) · [发行说明](https://github.com/dengyier/OpenWorkProof/releases/tag/v1.6.0) · [MCP Registry](https://registry.modelcontextprotocol.io/v0.1/servers/io.github.dengyier%2FOpenWorkProof/versions/1.6.0) +当前版本:**1.6.1** · [PyPI](https://pypi.org/project/openworkproof/1.6.1/) · [发行说明](https://github.com/dengyier/OpenWorkProof/releases/tag/v1.6.1) · [MCP Registry](https://registry.modelcontextprotocol.io/v0.1/servers/io.github.dengyier%2FOpenWorkProof/versions/1.6.1) ## 能帮你完成哪些事? @@ -32,7 +32,7 @@ OWP 不会自动监控电脑上所有 Agent 和工具。多个 Agent 的统一 "mcpServers": { "openworkproof": { "command": "uvx", - "args": ["openworkproof==1.6.0"] + "args": ["openworkproof==1.6.1"] } } } @@ -73,7 +73,7 @@ Skill 不会自动配置 MCP 或开启 Guard,仍需单独完成前面的 MCP 安装 CLI 后,在目标 Git 项目里创建 `preview` 目录和 `preview/index.html` 这样的文本文件,再运行: ```sh -uv tool install --python 3.12 'openworkproof==1.6.0' +uv tool install --python 3.12 'openworkproof==1.6.1' owp-guard install --project "$(pwd -P)" --allow-dir preview owp-guard enable --project "$(pwd -P)" owp-guard doctor --project "$(pwd -P)" diff --git a/docs/integrations/agent-guard-onboarding.en.md b/docs/integrations/agent-guard-onboarding.en.md index 60f64db..8076580 100644 --- a/docs/integrations/agent-guard-onboarding.en.md +++ b/docs/integrations/agent-guard-onboarding.en.md @@ -16,8 +16,8 @@ ordinary Codex window is not automatically protected. - Use a local POSIX environment, a working Git installation and Python 3.12. The recorded real-host baseline is **macOS, Python 3.12 and Codex CLI 0.147.0**. That live record was obtained for the 1.5.0 Guard implementation; the current - installation example uses package 1.6.0. It is not a new live acceptance claim - for every 1.6.0 environment. Check compatibility before using another host or + installation example uses package 1.6.1. It is not a new live acceptance claim + for every 1.6.1 environment. Check compatibility before using another host or version. Windows and WorkBuddy are not verified for this Guard workflow. - Have Codex CLI installed and signed in with your own account. `enable` runs a real Codex probe, and `run` executes a real Agent task. Both use your existing @@ -41,13 +41,15 @@ git init mkdir preview printf '\n