Skip to content

Commit f9c89a6

Browse files
committed
update readme
1 parent 371a14e commit f9c89a6

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,55 @@ A Docker image that provides access to HackerOne's GraphQL API through the Model
106106
- The `-i` flag is required to maintain standard input for the stdio transport
107107
- The `schema.graphql` in this repository may become outdated over time, you can download the latest one from HackerOne at [https://hackerone.com/schema.graphql](https://hackerone.com/schema.graphql)
108108

109+
## Development
110+
111+
### Creating a Release
112+
113+
To create a new release:
114+
115+
1. Create a [new release in GitHub](https://github.com/Hacker0x01/hackerone-graphql-mcp-server/releases/new).
116+
117+
2. GitHub Actions will automatically:
118+
- Build multi-architecture images (amd64, arm64)
119+
- Push to Docker Hub with appropriate tags
120+
- Update the `latest` tag
121+
122+
### Manual Build (Local Development)
123+
124+
For local development and testing:
125+
126+
```sh
127+
# Setup buildx
128+
docker buildx create --name multiarch --driver docker-container --use
129+
docker buildx inspect --bootstrap
130+
131+
# Build and push the image
132+
bin/build
133+
134+
# Clean up
135+
docker buildx rm multiarch
136+
```
137+
138+
### Debugging
139+
140+
1. **Run MCP inspector:**
141+
```sh
142+
npx @modelcontextprotocol/inspector
143+
```
144+
145+
3. **Connect to the HackerOne MCP server from the web interface:**
146+
147+
Command:
148+
```sh
149+
/usr/local/bin/docker
150+
```
151+
152+
Arguments:
153+
154+
```sh
155+
run -i --rm -e ENDPOINT=http://host.docker.internal:3000/graphql -e TOKEN=<TOKEN> -e ALLOW_MUTATIONS=all hackertwo/hackerone-graphql-mcp-server:1.0.5
156+
```
157+
109158
## Issues & Contributions
110159

111160
- **HackerOne-specific behavior, configuration, token handling, schema quirks, mutation allow-listing, etc.:** open an issue in this repository.

0 commit comments

Comments
 (0)