Skip to content

README rewrite, tool fixes, self-hosted HTTP image (0.3.0) - #3

Merged
mathieuduperre merged 2 commits into
mainfrom
feat/feedback-round
Oct 1, 2026
Merged

mathieuduperre merged 2 commits into
mainfrom
feat/feedback-round

Conversation

@mathieuduperre

Copy link
Copy Markdown
Contributor

Docs

  • README.md is now the user-facing integration guide, replacing the GitBook copy mcp-integration.md (deleted): GitHub alerts instead of {% hint %}, absolute docs.edgegap.com links, and Cursor / VS Code install buttons through their https redirects (GitHub strips cursor:// and vscode: links).
  • Fixed the conflicts with the old README: the stale @0.1.5 pin and the mixed edgegap / Edgegap server names.
  • Security model, allowlist scope and design decisions moved to DESIGN.md.

Tools

  • edgegap_generate_dockerfile: test_locally no longer adds --platform linux/amd64 to docker run. The flag stays on docker build.
  • edgegap_list_deployments: replaces the free-text filter with typed filters and order_by from the filtering guide. It builds the JSON query itself and refuses two filters on the same field.

Self-hosting

  • src/http.ts: the Worker's stateless Streamable HTTP design on plain Node. Each request carries its own token, any token in the environment is ignored, and discovery works without a token. The token handling is shared with the Worker through src/hosted.ts.
  • Dockerfile (node:22-alpine, non-root, /health healthcheck).
  • .github/workflows/ci.yml: typecheck, worker typecheck, build and tests on every PR and on pushes to main.
  • .github/workflows/docker.yml: on push to main or a v* tag, builds linux/amd64 and pushes registry.edgegap.com/<project>/edgegap-mcp with the tags main and sha-<commit>, plus the version on v* tags. Needs the EDGEGAP_REGISTRY_PROJECT variable and the EDGEGAP_REGISTRY_USERNAME / EDGEGAP_REGISTRY_TOKEN secrets.

Structure

  • Removed src/auth/, src/lib/ and src/tools/. Nothing compiled or imported them.
  • dist/ is no longer tracked and is now in .gitignore. server.json was removed from .gitignore, since that file is committed.
  • Test scripts moved to test/. Added test/http.mjs plus new list_deployments and --platform checks in test/newtools.mjs.
  • Version bumped to 0.3.0.

Testing

npm run build, npm run typecheck:worker and npm test all pass locally. The Docker image has not been built locally yet; the first CI run will be its first build.

🤖 Generated with Claude Code

Mathieu Duperre and others added 2 commits October 1, 2026 11:52
- README is now the user-facing integration guide (GitHub alerts, absolute
  docs links, Cursor/VS Code install buttons); security and design notes
  move to DESIGN.md.
- edgegap_generate_dockerfile: --platform only on docker build, not run.
- edgegap_list_deployments: structured filters and order_by from the
  filtering guide instead of a free-text filter.
- src/http.ts: stateless Streamable HTTP server on Node, sharing token
  handling with the Worker through src/hosted.ts.
- Dockerfile, CI workflow, and image push to the Edgegap registry.
- Test scripts move to test/; new http.mjs and list_deployments checks.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mathieuduperre
mathieuduperre merged commit 3b6430c into main Oct 1, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant