Repository navigation
docs: add a root README - #467
Conversation
The GitHub front page of this public repo was empty. The README says what Terminal49 is, maps each directory to what ships from it, gives short quick starts for the API, SDK, CLI, and hosted MCP server, and points contributors at the commands and generated-file rules in AGENTS.md. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 65fe46c2b8
ℹ️ 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".
|
|
||
| ### Connect the MCP server | ||
|
|
||
| Point your MCP client at `https://mcp.terminal49.com`. Use the root URL, not `/mcp`. The client signs you in with OAuth, so you do not need an API key. In Claude, add Terminal49 from the [Claude Directory](https://claude.ai/directory/connectors/terminal49). |
There was a problem hiding this comment.
Qualify the OAuth-only MCP quick start
For MCP clients that do not support a browser OAuth flow, this promise is incorrect: they cannot sign the user in and must instead send an API key, as documented in docs/mcp/home.mdx:66-69. Qualify these instructions for OAuth-capable clients or include the API-key fallback so the generic setup does not leave those clients unauthenticated.
AGENTS.md reference: AGENTS.md:L60-L62
Useful? React with 👍 / 👎.
| ```ts | ||
| import { Terminal49Client } from '@terminal49/sdk'; | ||
|
|
||
| const client = new Terminal49Client({ apiToken: process.env.T49_API_TOKEN! }); |
There was a problem hiding this comment.
The SDK quick start reads T49_API_TOKEN but never shows how to set it. If that variable is unset, someone following this section alone gets AuthenticationError('API token is required') before making a request. Add export T49_API_TOKEN=YOUR_API_KEY beside the install command, as the CLI example does.
Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 43
Comment:
**SDK setup skips the key**
The SDK quick start reads `T49_API_TOKEN` but never shows how to set it. If that variable is unset, someone following this section alone gets `AuthenticationError('API token is required')` before making a request. Add `export T49_API_TOKEN=YOUR_API_KEY` beside the install command, as the CLI example does.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.
What
Adds
README.mdat the repo root (90 lines). It covers:AGENTS.mdfor generated files.Why
The repo had no root README, so its GitHub front page was empty for API integrators, SDK and CLI users, and contributors.
Verification
docs/openapi.json), package and bin names (package.jsonfiles), the connector URL (AGENTS.md,docs/mcp/home.mdx), the Node version (.tool-versions), and the commands (AGENTS.md).AGENTS.mdanchors.docs/mcp/home.mdxalready uses the same Claude Directory link.vp run checkpasses. The README sits outsidedocs/, so Mintlify does not publish it.Open questions
SECURITY.md. The README points security reports tosupport@terminal49.com, the support address the docs use.LICENSE. Onlysdks/typescript-sdk-cli/(MIT) has one, so the README says nothing about the license.🤖 Generated with Claude Code
Need help on this PR? Tag
@codesmith-botwith what you need.The PR appears safe to merge, with a small setup gap in the SDK example.
Fix with agent prompt
Summary
Adds a root
README.mdwith:The SDK quick start should show how to set its API key.
Reviews (1) · Last reviewed commit: "docs: add a root README" · Reviewed by Greptile