docs(ai-mcp): document options/close()/expose modes, tidy internals#31
Merged
Conversation
Code quality + docs pass for @gemstack/ai-mcp: - README: fixed the "expose an Agent as an MCP server external clients" grammar; documented mcpClientTools options (filter/namePrefix/streaming) with an example; explained the close() lifecycle (present only when this call owns the connection); expanded the three expose modes and listed the remaining server options. - index.ts: same grammar fix in the module doc. - client-tools.ts: removed the unused RemoteTool.outputSchema field and a redundant buildTransport overload; documented the RemoteTool/MinimalClient internal interfaces and the deliberate unknown double-cast in resolveClient. - server-from-agent.ts: documented why safeInstructions swallows errors (best-effort optional metadata; pass opts.instructions to bypass). No public API change. Build + 19 tests green.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Code quality + docs pass for
@gemstack/ai-mcp(part of the per-package GemStack quality sweep).Docs (README)
mcpClientToolsoptions (filter/namePrefix/streaming) with an example.close()lifecycle: present only when this call owns the connection (HTTP / stdio), absent when you pass your ownClient.exposemodes and listed the remaining server options (name/version/instructions/agentToolName).Internals
RemoteTool.outputSchemafield and a redundantbuildTransportoverload.RemoteTool/MinimalClientinternal interfaces and the deliberateunknowndouble-cast inresolveClient.safeInstructionsswallows errors (best-effort optional metadata; passopts.instructionsto bypass).No public API change, so no changeset. Build + 19 tests green.