Skip to content

Document how to contribute #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mohsen1 merged 2 commits into from
Nov 4, 2026
Merged

Document how to contribute #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b205fd6
Document how to contribute
mohsen1 Nov 4, 2026
6d11fcf
Link to the public API documentation
mohsen1 Nov 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
Connect a coding agent to Proofline's hosted MCP server with `npx -y @proofline/mcp`.
Requires Node.js 22 or later. No CLI installation or runtime dependencies are needed.

## Contributing

This repository distributes the Proofline MCP bridge. The bridge discovers tools from the hosted MCP server at runtime. Open an issue for changes to the tool catalog or tool behavior. Pull requests are welcome for the hand-written bridge in `src/`, package scripts in `scripts/`, and tests in `tests/`.

## Add to your agent

Add this entry to an agent's MCP configuration, such as Cursor's `.cursor/mcp.json`
Expand Down Expand Up @@ -96,6 +100,4 @@ The initial package registration must exist on npm before configuring its truste
publisher. Release tags use `v` followed by the version in `package.json`.
A manual Release run defaults to qualification without publication.

The server contract and live client qualification are maintained in
[the developer tools documentation](https://proofline.sh/docs/) and
[the MCP roadmap issue](https://github.com/prooflinedev/proofline/issues/3246).
See the [developer tools documentation](https://proofline.sh/docs/) for the hosted API.
Loading