Skip to content

docs(vmcp): document core transport split#5673

Open
buyicoder wants to merge 1 commit into
stacklok:mainfrom
buyicoder:docs-vmcp-architecture-api
Open

docs(vmcp): document core transport split#5673
buyicoder wants to merge 1 commit into
stacklok:mainfrom
buyicoder:docs-vmcp-architecture-api

Conversation

@buyicoder

Copy link
Copy Markdown

Summary

  • Document the current vMCP core/transport split in the architecture overview and embedding guide.
  • Refresh the embedding guidance and stability table for pkg/vmcp/core, server.Serve, and the stable server.New wrapper.
  • Update the root pkg/vmcp package docs to describe core.VMCP, subtract-only decorators, and the supported outer handler wrapping pattern.

Test plan

  • git diff --check
  • Not run: gofmt, go test ./pkg/vmcp/..., and task docs because gofmt, go, and task are not available in my local PATH.

Closes #5446.

Refresh the vMCP embedding docs and package comment so embedders see the current core.New/server.Serve API, decorator model, and stable server.New wrapper.

Co-authored-by: Cursor <cursoragent@cursor.com>
@buyicoder

Copy link
Copy Markdown
Author

Thanks for the detailed issue write-up. I kept this docs-only and aligned the wording with the current pkg/vmcp/core + pkg/vmcp/server split I found in main, including the stable server.New wrapper path.

I could only run git diff --check locally because Go/Task are not installed in this environment, so I called that out in the PR body.

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.

P4.1 Update vMCP architecture docs + doc.go

1 participant