Skip to content

Commit 9ed24d1

Browse files
authored
fill in the README to not be boilerplate (#19)
1 parent ccbea9c commit 9ed24d1

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

README.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,36 @@
1-
# Shoal Software Pants Model Context Plugin
1+
# Pantsbuild Model Context Protocol Plugin
22

3-
Provides a Model Contect Protocol ("MCP") for a Pants repository for LLM agents to make use of.
3+
## Overview
4+
5+
This project is an **experimental** plugin to the [Pantsbuild](https://pantsbuild.org/) build orchestration tool to expose a Model Contect Protocol ("MCP") server for LLM coding agents to interact with.
46

57
## Installation
68

7-
TBD
9+
From PyPI:
810

9-
## Usage
11+
1. In the relevant Pants project, edit `pants.toml` to set the `[GLOBAL].plugins` option to include `shoalsoft-pants-mcp-plugin==VERSION` (replacing `VERSION` with the applicable version) and the `[GLOBAL].backend_packages` option to include `shoalsoft.pants_mcp_plugin`.
1012

11-
TBD
13+
2. Confogure your LLM coding agent to invoke `pants shoalsoft-mcp --run-stdio-server` in the repository as follows:
1214

13-
## Configuration
15+
- [Claude Code setup](https://docs.claude.com/en/docs/claude-code/mcp#option-1%3A-add-a-local-stdio-server)
16+
- [ChatGPT Codex setup](https://github.com/openai/codex/blob/main/docs/advanced.md#model-context-protocol-mcp)
1417

15-
TBD
18+
## Usage
19+
20+
If the MCP server is started correctly by your LLM coding agent, then the agent should take advantage of the exposed MCP tools, which include a tool for each Pants goals.
1621

1722
## Development
1823

19-
TBD
24+
### Workflow
25+
26+
- Run formating and type checks (mypy): `pants fmt lint check ::`
27+
28+
- Run tests: `pants test ::`
2029

2130
### Building
2231

2332
TBD
2433

2534
## License
2635

27-
This is commercial software and requires prior permission to use.
36+
This is currently commercial software and requires prior permission to use. See the [LICENSE](./LICENSE) file in this repository for specific details.

0 commit comments

Comments
 (0)