-
Notifications
You must be signed in to change notification settings - Fork 15
Add README #123
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
adi-singh13
wants to merge
2
commits into
main
Choose a base branch
from
jarvis/add-readme
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add README #123
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # AgentMail Documentation | ||
|
|
||
| The source for [docs.agentmail.to](https://docs.agentmail.to) — API documentation for AgentMail, the email API for AI agents. | ||
|
|
||
| Built with [Fern](https://buildwithfern.com). | ||
|
|
||
| ## Structure | ||
|
|
||
| ``` | ||
| fern/ | ||
| ├── definition/ # API definition (Fern format) | ||
| ├── pages/ # Documentation pages (MDX) | ||
| ├── changelog/ # Changelog entries | ||
| ├── generators.yml # SDK generation config (Python, TypeScript, Go) | ||
| ├── docs.yml # Documentation site config | ||
| └── fern.config.json # Fern project config | ||
| ``` | ||
|
|
||
| ## SDK Generation | ||
|
|
||
| This repo also configures SDK generation via Fern: | ||
|
|
||
| | SDK | Package | Repo | | ||
| |---|---|---| | ||
| | Python | [`agentmail`](https://pypi.org/project/agentmail) | [agentmail-python](https://github.com/agentmail-to/agentmail-python) | | ||
| | TypeScript | [`agentmail`](https://www.npmjs.com/package/agentmail) | [agentmail-node](https://github.com/agentmail-to/agentmail-node) | | ||
| | Go | [`agentmail-go`](https://pkg.go.dev/github.com/agentmail-to/agentmail-go) | [agentmail-go](https://github.com/agentmail-to/agentmail-go) | | ||
|
|
||
| ## Links | ||
|
|
||
| - [AgentMail](https://agentmail.to) — The email API for AI agents | ||
| - [API Documentation](https://docs.agentmail.to) | ||
| - [Console](https://console.agentmail.to) | ||
| - [GitHub](https://github.com/agentmail-to) |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| #!/usr/bin/env bash | ||
| # Update GitHub repo descriptions, homepage URLs, and topics for all agentmail-to public repos. | ||
| # Requires a GitHub token with admin access to the agentmail-to org. | ||
| # | ||
| # Usage: | ||
| # GITHUB_TOKEN=ghp_xxx ./scripts/update-repo-metadata.sh | ||
| # | ||
| # Or pass as argument: | ||
| # ./scripts/update-repo-metadata.sh ghp_xxx | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| TOKEN="${1:-${GITHUB_TOKEN:-}}" | ||
| if [ -z "$TOKEN" ]; then | ||
| echo "Error: Pass a GitHub token as argument or set GITHUB_TOKEN env var" | ||
| exit 1 | ||
| fi | ||
|
|
||
| API="https://api.github.com" | ||
| ORG="agentmail-to" | ||
| AUTH=(-H "Authorization: token $TOKEN" -H "Accept: application/vnd.github+json") | ||
|
|
||
| patch_repo() { | ||
| local repo="$1" desc="$2" homepage="$3" | ||
| echo "→ $repo" | ||
| curl -sf -X PATCH "${AUTH[@]}" "$API/repos/$ORG/$repo" \ | ||
| -d "{\"description\":$(jq -n --arg d "$desc" '$d'),\"homepage\":$(jq -n --arg h "$homepage" '$h')}" \ | ||
| | jq '{name, description, homepage}' || echo " ✗ FAILED (need admin?)" | ||
| } | ||
|
|
||
| set_topics() { | ||
| local repo="$1" | ||
| shift | ||
| local topics | ||
| topics=$(printf '"%s",' "$@" | sed 's/,$//') | ||
| curl -sf -X PUT "${AUTH[@]}" "$API/repos/$ORG/$repo/topics" \ | ||
| -d "{\"names\":[$topics]}" \ | ||
| | jq '.names' || echo " ✗ FAILED (need admin?)" | ||
| } | ||
|
|
||
| echo "=== Updating descriptions & homepage URLs ===" | ||
|
|
||
| patch_repo "agentmail-python" \ | ||
| "Official Python SDK for AgentMail — the email API for AI agents" \ | ||
| "https://pypi.org/project/agentmail" | ||
|
|
||
| patch_repo "agentmail-node" \ | ||
| "Official TypeScript/Node SDK for AgentMail — the email API for AI agents" \ | ||
| "https://www.npmjs.com/package/agentmail" | ||
|
|
||
| patch_repo "agentmail-go" \ | ||
| "Official Go SDK for AgentMail — the email API for AI agents" \ | ||
| "https://pkg.go.dev/github.com/agentmail-to/agentmail-go" | ||
|
|
||
| patch_repo "agentmail-toolkit" \ | ||
| "AgentMail integrations for OpenAI Agents SDK, Vercel AI SDK, and MCP" \ | ||
| "https://agentmail.to" | ||
|
|
||
| patch_repo "agentmail-mcp" \ | ||
| "AgentMail MCP Server — connect AI clients (Claude, Cursor, Windsurf) to email" \ | ||
| "https://mcp.agentmail.to" | ||
|
|
||
| patch_repo "agentmail-cli" \ | ||
| "Official CLI for AgentMail — manage inboxes, send and receive email from the terminal" \ | ||
| "https://docs.agentmail.to" | ||
|
|
||
| patch_repo "agentmail-docs" \ | ||
| "AgentMail API documentation" \ | ||
| "https://docs.agentmail.to" | ||
|
|
||
| patch_repo "agentmail-examples" \ | ||
| "Example agents built with AgentMail — email agents, sales outreach, and more" \ | ||
| "https://agentmail.to" | ||
|
|
||
| patch_repo "agentmail-skills" \ | ||
| "AgentMail skills for Claude Code and other AI coding agents" \ | ||
| "https://agentmail.to" | ||
|
|
||
| patch_repo "agentmail-schemas" \ | ||
| "AgentMail API schemas and type definitions" \ | ||
| "https://docs.agentmail.to" | ||
|
|
||
| patch_repo "agentmail-claude-skill" \ | ||
| "Claude Skill that teaches Claude how to build email agents with AgentMail" \ | ||
| "https://agentmail.to" | ||
|
|
||
| patch_repo "agentmail-smithery-mcp" \ | ||
| "AgentMail MCP Server for Smithery" \ | ||
| "https://smithery.ai" | ||
|
|
||
| patch_repo "homebrew-tap" \ | ||
| "Homebrew tap for AgentMail CLI" \ | ||
| "https://agentmail.to" | ||
|
|
||
| patch_repo "ai-email-agent-template" \ | ||
| "AI Email Agent template — built with AgentMail + OpenAI. Fork on Replit to get started." \ | ||
| "https://agentmail.to" | ||
|
|
||
| echo "" | ||
| echo "=== Updating topics ===" | ||
|
|
||
| set_topics "agentmail-python" \ | ||
| python sdk email ai-agents email-api agentmail | ||
|
|
||
| set_topics "agentmail-node" \ | ||
| typescript nodejs sdk email ai-agents email-api agentmail | ||
|
|
||
| set_topics "agentmail-go" \ | ||
| go golang sdk email ai-agents email-api agentmail | ||
|
|
||
| set_topics "agentmail-toolkit" \ | ||
| openai vercel-ai mcp ai-agents email agentmail langchain | ||
|
|
||
| set_topics "agentmail-mcp" \ | ||
| mcp model-context-protocol claude cursor ai-agents email agentmail | ||
|
|
||
| set_topics "agentmail-cli" \ | ||
| cli email ai-agents agentmail terminal | ||
|
|
||
| set_topics "agentmail-docs" \ | ||
| documentation api-docs email-api agentmail | ||
|
|
||
| set_topics "agentmail-examples" \ | ||
| examples email-agent ai-agents agentmail python | ||
|
|
||
| set_topics "agentmail-skills" \ | ||
| claude-code ai-coding-agent skills agentmail | ||
|
|
||
| set_topics "agentmail-schemas" \ | ||
| schemas typescript zod email-api agentmail | ||
|
|
||
| set_topics "agentmail-claude-skill" \ | ||
| claude claude-skill ai-agents email agentmail | ||
|
|
||
| set_topics "agentmail-mcp" \ | ||
| mcp model-context-protocol claude cursor ai-agents email agentmail | ||
|
|
||
| set_topics "homebrew-tap" \ | ||
| homebrew cli agentmail | ||
|
|
||
| set_topics "ai-email-agent-template" \ | ||
| template email-agent ai-agents openai replit agentmail | ||
|
|
||
| echo "" | ||
| echo "✓ Done! Check https://github.com/agentmail-to to verify." | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P2:
agentmail-mcpis updated twice in topics, soagentmail-smithery-mcpnever gets topics set.Prompt for AI agents