docs(server-core): add README with package overview and usage example by nuthalapativarun · Pull Request #1331 · VoltAgent/voltagent

nuthalapativarun · 2026-05-29T20:10:53Z

PR Checklist

Commit message follows conventional commits: <type>(<scope>): <description>
Related issue(s) linked
Tests added/updated
Docs added/updated if needed
Changeset created via pnpm changeset

What is the current behavior?

@voltagent/server-core has no README.md.

What is the new behavior?

A README documents the package purpose, key exports, and a minimal TypeScript usage example.

fixes #1330

Notes for reviewers

Content is derived from the package source. Style mirrors packages/core/README.md.

Summary by cubic

Added a README for @voltagent/server-core with an overview, key exports, and a minimal example for building a custom server adapter. Addresses #1330 by documenting package purpose, usage, the ./edge entry, and correcting handler and registry names for accuracy.

^{Written for commit 7fb4776. Summary will update on new commits.}

Summary by CodeRabbit

Documentation
- Added comprehensive README for the server-core package describing its purpose, key public components and utilities, usage guidance for creating custom server adapters, example integration notes, links to further docs, and license information.
Chores
- Added a Changeset entry to register the documentation update as a patch release.

changeset-bot · 2026-05-29T20:10:58Z

🦋 Changeset detected

Latest commit: 7fb4776

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@voltagent/server-core	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

coderabbitai · 2026-05-29T20:11:06Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 902157fc-29bb-4903-a588-65848d15fb2b

📥 Commits

Reviewing files that changed from the base of the PR and between 8f2eb3c and 7fb4776.

📒 Files selected for processing (1)

packages/server-core/README.md

✅ Files skipped from review due to trivial changes (1)

packages/server-core/README.md

📝 Walkthrough

Walkthrough

Added a comprehensive README for the @voltagent/server-core package documenting its purpose as framework-agnostic server infrastructure, listing key exported components and utilities, providing a custom server adapter implementation example, and including links to further documentation and license information. Also added release metadata via a Changesets file.

Changes

Package Documentation

Layer / File(s)	Summary
README and Release Metadata `packages/server-core/README.md`, `.changeset/server-core-readme.md`	Introduced comprehensive README covering package overview, Key Exports inventory (BaseServerProvider, route metadata, request handlers, authentication, WebSocket utilities, MCP/A2A helpers, app setup utilities, and edge entry point), a TypeScript usage example demonstrating extending `BaseServerProvider` and integrating a factory with `VoltAgent`, documentation links, and MIT license. Added a Changesets patch entry tracking the README addition.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

omeraplak

Poem

🐰 Hop, hop—a README freshly penned,

Server-core docs for every friend.
Adapter examples clear and neat,
Exports listed, usage sweet.
Cheers from a rabbit—read and ship!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the main change: adding a README to the server-core package with package overview and usage example.
Description check	✅ Passed	The description follows the template with all key sections filled out, including checklist items, current/new behavior, linked issue, and reviewer notes. It aligns with the PR objectives and changeset requirements.
Linked Issues check	✅ Passed	The PR fully addresses issue `#1330` by adding a README documenting package purpose, key exports, and a minimal usage example, mirroring the style of packages/core/README.md as requested.
Out of Scope Changes check	✅ Passed	All changes are directly related to the objectives: a README file and a changeset entry documenting the new package documentation, with no extraneous modifications.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

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.}

coderabbitai

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@packages/server-core/README.md`:
- Around line 68-77: Update the observability handler names in the README to
match the actual exports: replace handleGetTraces with getTracesHandler,
handleGetTraceById with getTraceByIdHandler, and handleGetObservabilityStatus
with getObservabilityStatusHandler so the listed observability handlers match
the exported symbols (verify the surrounding list of handlers like
handleGenerateText, handleGetWorkflows, handleListTools,
handleListMemoryConversations, handleGetLogs remains unchanged).
- Around line 79-106: Update the README to use the actual exported registry/type
and helper names: replace any references to "McpRegistry" and "A2ARegistry" with
"MCPServerRegistry" and "A2AServerRegistry", and update helper function names to
"listMcpServers" / "lookupMcpServer" and "listA2AServers" / "lookupA2AServer"
(instead of the generic "buildMcpRoutePaths" or "resolveAgentCard" names if
present), so the README matches the real public exports.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 703a8db6-9cc5-43b7-89ad-d81c10c349e6

📥 Commits

Reviewing files that changed from the base of the PR and between 41cad53 and 8f2eb3c.

📒 Files selected for processing (2)

.changeset/server-core-readme.md
packages/server-core/README.md

cubic-dev-ai

2 issues found across 2 files

_{Reply with feedback, questions, or to request a fix.

Re-trigger cubic}

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

docs(server-core): add README with package overview and usage example

8f2eb3c

coderabbitai Bot reviewed May 29, 2026

View reviewed changes

Comment thread packages/server-core/README.md

Comment thread packages/server-core/README.md

cubic-dev-ai Bot reviewed May 29, 2026

View reviewed changes

Comment thread packages/server-core/README.md Outdated

Comment thread packages/server-core/README.md Outdated

docs(server-core): fix incorrect handler and registry names in README

7fb4776

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs(server-core): add README with package overview and usage example#1331

docs(server-core): add README with package overview and usage example#1331
nuthalapativarun wants to merge 2 commits into
VoltAgent:mainfrom
nuthalapativarun:docs/1330-server-core-readme-worktree

nuthalapativarun commented May 29, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

changeset-bot Bot commented May 29, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented May 29, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Suggested reviewers

Poem

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

cubic-dev-ai Bot left a comment •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

nuthalapativarun commented May 29, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Checklist

What is the current behavior?

What is the new behavior?

Notes for reviewers

Summary by cubic

Summary by CodeRabbit

Uh oh!

changeset-bot Bot commented May 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

coderabbitai Bot commented May 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Suggested reviewers

Poem

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

cubic-dev-ai Bot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

nuthalapativarun commented May 29, 2026 •

edited by coderabbitai Bot

Loading

changeset-bot Bot commented May 29, 2026 •

edited

Loading

coderabbitai Bot commented May 29, 2026 •

edited

Loading

cubic-dev-ai Bot left a comment •

edited

Loading