Skip to main content

Evidence-bound harness for agent-assisted CS paper drafting.

Project description

cs-paper-harness

Language: English | 中文

cs-paper-harness is an evidence-bound, agent-first harness for Computer Science graduate paper workflows in Codex and Claude Code.

The project is not a paper-writing bot, a LaTeX formatter, or a prompt collection. It gives the agent a protocol for preserving context, evidence boundaries, direct-edit recovery, and handoff state while the student works toward a credible paper.md draft.

Install

Install the runtime:

pipx install cs-paper-harness==1.0.0
cph --help

Configure a paper workspace, global agent surfaces, or both:

cph-install --scope project --agent codex --project /path/to/paper-workspace
cph-install --scope global --agent all
cph-install --scope both --agent all --project /path/to/paper-workspace

project scope writes only workspace-local guidance and .cs-paper/ private state setup. global scope installs Codex and Claude Code skill surfaces into normal user discovery paths. both performs both actions explicitly.

Student Path

Start here if you want to use CPH for a paper:

AI-readable project assets are available at llms.txt, llms-full.txt, and docs/project-knowledge.md.

Core Idea

Models should think, discuss, analyze, and write. The harness should preserve state, evidence, gates, and handoff.

In plain terms:

  • The model is the runner.
  • The agent is the running interface and tool surface.
  • CPH is the guardrail, checkpoint, and relay protocol.

CPH does not replace the agent interface. A student still works inside Claude Code or Codex. CPH constrains the process so the agent does not skip evidence, forget decisions after context compaction, or write claims stronger than the available artifacts.

V1 Outcome

V1 starts when a student says something like:

  • I want to do research about X.
  • I want to write a CS paper, but I am not sure about the direction.
  • I already have an idea, experiment folder, or partial draft.

V1 ends with:

  • paper.md
  • references.bib
  • references.md

V1 does not include formatting, LaTeX, Word, submission packaging, automatic experiment execution, or a full venue database.

Workflow

  1. Initialization
  2. Direction confirmation
  3. Idea planning
  4. Experiment artifact analysis
  5. Evidence-core writing
  6. Storyline planning
  7. Introduction draft and framing audit
  8. Discussion and limitations
  9. Related Work and citation pass
  10. Conclusion
  11. Assembly, polish, and final audit

The writing order is evidence-first. For most empirical CS papers, method/system and experiments/findings should be written before Introduction, because Introduction is where unsupported over-framing is most likely to appear.

Runtime Boundary

The cph runtime exposes only deterministic protocol operations:

  • cph init
  • cph doctor
  • cph manifest
  • cph assemble
  • cph handoff

The runtime does not judge research novelty, paper quality, evidence support, final audit quality, or whether to keep, discard, or defer direct paper.md edits. Those decisions stay with the student and the agent workflow.

Local Verification

From the repository root:

env UV_CACHE_DIR=/tmp/uv-cache uv lock --offline
env UV_CACHE_DIR=/tmp/uv-cache uv run cph --help
env UV_CACHE_DIR=/tmp/uv-cache uv run cph doctor
jq empty schemas/*.schema.json
env UV_CACHE_DIR=/tmp/uv-cache uv run pytest

The committed synthetic demo workspace has its own deterministic gate:

cd examples/self-referential-demo
env UV_CACHE_DIR=/tmp/uv-cache uv run cph doctor
env UV_CACHE_DIR=/tmp/uv-cache uv run cph manifest list
env UV_CACHE_DIR=/tmp/uv-cache uv run cph manifest check
env UV_CACHE_DIR=/tmp/uv-cache uv run cph assemble
env UV_CACHE_DIR=/tmp/uv-cache uv run cph handoff

For a copyable toy workspace flow, see docs/getting-started-walkthrough.md.

Privacy

Real paper workspaces should keep these files private and ignored by git:

.cs-paper/
AGENTS.md
CLAUDE.md

Only examples/self-referential-demo may commit synthetic .cs-paper/ state.

Maintainer References

The project is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cs_paper_harness-1.0.0.tar.gz (264.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cs_paper_harness-1.0.0-py3-none-any.whl (36.2 kB view details)

Uploaded Python 3

File details

Details for the file cs_paper_harness-1.0.0.tar.gz.

File metadata

  • Download URL: cs_paper_harness-1.0.0.tar.gz
  • Upload date:
  • Size: 264.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for cs_paper_harness-1.0.0.tar.gz
Algorithm Hash digest
SHA256 d6501f73cd89a76d6566342af6306282196409d90a2118301b0ed1c3dbda3f52
MD5 85be1c1016d3423994411ac58eed6df2
BLAKE2b-256 9216e0c3473963bc88d267aaad9fb9a3288c2d892da2ea4cf4d472b71b8020c1

See more details on using hashes here.

Provenance

The following attestation bundles were made for cs_paper_harness-1.0.0.tar.gz:

Publisher: publish-pypi.yml on pumblus/cs-paper-harness

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cs_paper_harness-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for cs_paper_harness-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3fd42f284ac0a10ed3990be31b7869cdfb715330886761a20b023116590cb5ee
MD5 7006a3ea42957d11793ac2d2609905f0
BLAKE2b-256 5df7c393bdf92ce54e3bb3c86992a1ce1b43f2bf5d896f11083f43c4bda6b181

See more details on using hashes here.

Provenance

The following attestation bundles were made for cs_paper_harness-1.0.0-py3-none-any.whl:

Publisher: publish-pypi.yml on pumblus/cs-paper-harness

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page