Skip to content

Conversation

Cali0707
Copy link
Collaborator

@Cali0707 Cali0707 commented Oct 16, 2025

Resolves #178

This PR updates the CHANGELOG with the new features in v0.1, as well as adds the new CLI commands to the README

Summary by CodeRabbit

  • New Features

    • Added runtime overrides, tool annotations, and server instructions.
    • Introduced logging, JSON schema validation, and structured HTTP responses.
    • Added new CLI commands: build (container image creation) and version (display version information).
  • Breaking Changes

    • Simplified mcpfile format with embedded server fields; migrated to v0.1.0 format.
  • Updated Dependencies

    • Updated to Model Context Protocol Go SDK v1.0.0.
  • Documentation

    • Updated README with new command references.

@Cali0707 Cali0707 requested a review from a team as a code owner October 16, 2025 14:52
Copy link

coderabbitai bot commented Oct 16, 2025

Walkthrough

Documentation updates for v0.1 release: CHANGELOG expanded with new features, breaking changes, and contributor credits; README updated with two additional CLI commands (build and version).

Changes

Cohort / File(s) Summary
Documentation Updates
CHANGELOG.md
Expanded v0.1.0 Added section with runtime overrides, tool annotations, logging, JSON schema validation, MCP primitives, and CLI commands. Updated Changed section with BREAKING mcpfile format simplification and SDK migration to Model Context Protocol Go v1.0.0. Added New Contributors subsection.
CLI Documentation
README.md
Added two Core Commands entries: build (container image building) and version (version display).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 The changelog hops with tales so grand,
New features sprouting across the land,
v0.1 takes flight with breaking news,
Build and version commands—a rabbit's muse!
Contributors cheered in rows so neat,
Release notes complete, the changes are sweet! 🎉

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The pull request title "docs: update CHANGELOG and README for v0.1" directly and clearly summarizes the main changes in the changeset. It uses the conventional commit style with a "docs:" prefix, specifies the affected files (CHANGELOG and README), and indicates the scope (v0.1 documentation updates). The title is concise, specific enough for teammates to understand the primary change when scanning history, and accurately reflects the content of the modifications without noise or vagueness.
Linked Issues Check ✅ Passed Issue #178 requires reviewing v0.1 changes and making appropriate documentation updates to at minimum the README and CHANGELOG to reflect v0.1 changes. The PR successfully addresses these requirements by updating the CHANGELOG with new features, changes (including the breaking mcpfile format change), and new contributors, and by updating the README with the new CLI commands (build and version). All coding-related documentation objectives from the linked issue have been met.
Out of Scope Changes Check ✅ Passed The pull request modifications are limited to two documentation files: CHANGELOG.md and README.md. All changes directly support the stated objective of documenting v0.1 features and updates. The CHANGELOG updates comprehensively reflect v0.1 additions, breaking changes, and contributors, while the README updates add the new CLI commands. No unrelated code changes, refactoring, or features outside the documentation update scope have been introduced.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b2faeff and d6b8bde.

📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • README.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md

[grammar] ~89-~89: There might be a mistake here.
Context: ...uild -f myapi.yaml --tag myapi:latest| |version` | Display version informatio...

(QB_NEW_EN)

CHANGELOG.md

[grammar] ~11-~11: There might be a mistake here.
Context: ...ent variable overrides in mcpfile (#177) - Tool annotations support (destructiveHin...

(QB_NEW_EN)


[grammar] ~12-~12: There might be a mistake here.
Context: ...indicate tool behavior to clients (#180) - Server instructions support to provide c...

(QB_NEW_EN)


[grammar] ~13-~13: There might be a mistake here.
Context: ...upport to provide context to LLMs (#173) - Comprehensive logging system with invoca...

(QB_NEW_EN)


[grammar] ~14-~14: There might be a mistake here.
Context: ...m with invocation and server logs (#168) - JSON schema validation for mcpfile (#155...

(QB_NEW_EN)


[grammar] ~15-~15: There might be a mistake here.
Context: ...SON schema validation for mcpfile (#155) - Support for MCP spec resource and `res...

(QB_NEW_EN)


[grammar] ~16-~16: There might be a mistake here.
Context: ...and resourceTemplate primitives (#157) - Support for MCP spec Prompts (#138) - ...

(QB_NEW_EN)


[grammar] ~18-~18: There might be a mistake here.
Context: ...te container images from mcpfiles (#126) - AI-based converter for CLI tools (#67) -...

(QB_NEW_EN)


[grammar] ~19-~19: There might be a mistake here.
Context: ...- AI-based converter for CLI tools (#67) - Structured output from HTTP JSON respons...

(QB_NEW_EN)


[grammar] ~21-~21: There might be a mistake here.
Context: ...(#107) - genmcp version command (#105) - gRPC integration demo showcasing GenMCP ...

(QB_NEW_EN)


[grammar] ~24-~24: There might be a mistake here.
Context: ...P with gRPC services (#153) ### Changed - BREAKING: Simplified mcpfile format by...

(QB_NEW_EN)


[grammar] ~25-~25: There might be a mistake here.
Context: ...migrated format version to v0.1.0 (#137) - GenMCP now uses the official [Model Cont...

(QB_NEW_EN)


[grammar] ~26-~26: There might be a mistake here.
Context: ...b.com/modelcontextprotocol/go-sdk) (#90) - Bumped MCP Go-SDK to v1.0.0 release (#13...

(QB_NEW_EN)


[grammar] ~27-~27: There might be a mistake here.
Context: ...mped MCP Go-SDK to v1.0.0 release (#134) - StreamableHttp servers are now configura...

(QB_NEW_EN)


[grammar] ~28-~28: There might be a mistake here.
Context: ... or stateful (default: stateless) (#100) - Migrated from ghodss/yaml to sigs.k8s.io...

(QB_NEW_EN)


[grammar] ~47-~47: There might be a mistake here.
Context: ...#83) ### Security ### New Contributors - @mikelolasagasti made their first contri...

(QB_NEW_EN)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Unit Tests
  • GitHub Check: lint

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@aliok
Copy link
Collaborator

aliok commented Oct 16, 2025

All good, just one comment...

Are we graciously failing if the mcp file version is not good?

@Cali0707
Copy link
Collaborator Author

Cali0707 commented Oct 16, 2025

Are we graciously failing if the mcp file version is not good?

@aliok this was added in #171 😄

Copy link
Collaborator

@aliok aliok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Cali0707 Cali0707 merged commit 461656a into genmcp:main Oct 16, 2025
4 checks 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.

v0.1 documentation updates

2 participants