docs: restore README files for both packages#93
Conversation
The README files were lost during the monorepo consolidation from the separate @gleanwork/mcp-config-schema and @gleanwork/mcp-config repos. - Restore mcp-config-schema README from npm tarball v3.1.1 - Create mcp-config-glean README adapted from old @gleanwork/mcp-config - Update both READMEs with current API changes (new methods, types, clients) - Remove duplicate Configuration File Locations table (now only in CLIENTS.md) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
steve-calvert-glean
added
the
documentation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: dd6b51b353
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
packages/mcp-config-schema/README.md
Outdated
| - `validateMcpServersConfig(config)` - Validate standard MCP servers config | ||
| - `validateVsCodeConfig(config)` - Validate VS Code config format | ||
| - `validateGooseConfig(config)` - Validate Goose config format | ||
| - `validateCodexConfig(config)` - Validate Codex config format |
There was a problem hiding this comment.
The README advertises validateCodexConfig, but the public entrypoints (src/types.ts re-exports and src/index.ts) never export that symbol, so consumers who follow this doc and try import { validateCodexConfig } from '@gleanwork/mcp-config-schema' will hit a missing-export error at build/runtime. Either export validateCodexConfig from types.ts (and browser.ts if applicable) or remove it from the README to avoid broken imports.
Useful? React with 👍 / 👎.
This function exists in schemas.ts but is not re-exported from types.ts, so it's not part of the public API. Removing from docs to match actual exports. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Replace detailed API lists with pointer to TypeScript source files. The types and JSDoc comments are the source of truth - duplicating them in the README is error-prone and hard to maintain. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 participant
The README files were lost during the monorepo consolidation from the separate @gleanwork/mcp-config-schema and @gleanwork/mcp-config repos.