Skip to content

docs: add a root README - #467

Merged
dodeja merged 1 commit into
mainfrom
docs/root-readme
Oct 19, 2026
Merged

dodeja merged 1 commit into
mainfrom
docs/root-readme

Conversation

@dodeja

@dodeja dodeja commented Oct 19, 2026 •

Copy link
Copy Markdown
Member

What

Adds README.md at the repo root (90 lines). It covers:

  • What Terminal49 is and what this repo contains.
  • A table that maps each directory to what ships from it.
  • Quick starts for curl, the SDK, the CLI, and the hosted MCP server.
  • Development commands, with links to AGENTS.md for generated files.
  • A security note.

Why

The repo had no root README, so its GitHub front page was empty for API integrators, SDK and CLI users, and contributors.

Verification

  • Checked every fact against the source: the auth header (docs/openapi.json), package and bin names (package.json files), the connector URL (AGENTS.md, docs/mcp/home.mdx), the Node version (.tool-versions), and the commands (AGENTS.md).
  • All relative links resolve, including the AGENTS.md anchors.
  • Docs-site, developer-portal, and viteplus.dev URLs return 200.
  • The npmjs.com and claude.ai links return a Cloudflare challenge (403) to curl. Both npm packages exist in the registry, and docs/mcp/home.mdx already uses the same Claude Directory link.
  • vp run check passes. The README sits outside docs/, so Mintlify does not publish it.

Open questions

  • The repo has no SECURITY.md. The README points security reports to support@terminal49.com, the support address the docs use.
  • The repo has no root LICENSE. Only sdks/typescript-sdk-cli/ (MIT) has one, so the README says nothing about the license.

🤖 Generated with Claude Code


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need.

RetriggerView in GreptileConfidence Score: 4/5

The PR appears safe to merge, with a small setup gap in the SDK example.

Fix All in CodexFindings

  1. P2 SDK setup skips the key ▶
Fix with agent prompt
### Issue 1
README.md:43
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.

Summary

Adds a root README.md with:

  • API and client users can find a starting point in the root README.
  • Contributors can find setup steps and working rules in the root README.

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

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>
@vercel

vercel Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
api Ready Ready Preview Oct 19, 2026 4:23am UTC

Request Review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-19T04:24:41.646428Z 65fe46c PR opened
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread README.md

### 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).

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

Comment thread README.md
```ts
import { Terminal49Client } from '@terminal49/sdk';

const client = new Terminal49Client({ apiToken: process.env.T49_API_TOKEN! });

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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.

Fix in Codex Fix in Claude Code

@dodeja
dodeja merged commit bddfb51 into main Oct 19, 2026
29 of 33 checks passed
@dodeja
dodeja deleted the docs/root-readme branch October 19, 2026 04:35

This branch was successfully deployed

1 active deployment
Preview — 65fe46c2 Deployed Oct 19, 2026 by vercel[bot]
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.

1 participant