Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Guidance for Claude Code (claude.ai/code) when working in this repository.

Meant to be used **without cloning**.

- **npm package `@agentailor/mcp`** (live) — `npx @agentailor/mcp` runs the stdio server (Claude Desktop). The `bin` maps to `dist/index.stdio.js`, which carries a `#!/usr/bin/env node` shebang.
- **npm package `@agentailor/mcp`** (live) — `npx -y @agentailor/mcp` runs the stdio server, so any MCP client can launch it (Claude Desktop, Cursor, VS Code/Copilot, Codex, and others — the README has per-client config). The `bin` maps to `dist/index.stdio.js`, which carries a `#!/usr/bin/env node` shebang.
- **Hosted HTTP** (planned, not live yet — presented as "coming soon" in the README) — the HTTP transport runs on a native Node host: build `pnpm install --frozen-lockfile && pnpm build`, start `pnpm start:http`. `GITHUB_TOKEN` is set as a secret; `PORT` is injected by the host; health check is `/health`. Node 20 pinned via `engines` + `.node-version`. Self-hosters can run this today; the _Agentailor-hosted_ endpoint is not yet published.

Clone-and-run is a secondary/contributor path. The `Dockerfile` is for local stdio and self-hosting anywhere.
Expand Down
79 changes: 76 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,32 @@ Scope is Agentailor's public content: the blog and the open-source org repos. Th

## Use it

### npx (local stdio)
### Connect your client (local stdio via npx)

Run the server as a local command — ideal for Claude Desktop. In `claude_desktop_config.json`:
The server runs as a local stdio command — `npx -y @agentailor/mcp` — so any MCP client can launch it. Add the config for your client below. No install step; `npx` fetches the package on first run.

<details open>
<summary><strong>Claude Desktop</strong></summary>

In `claude_desktop_config.json` (Settings › Developer › Edit Config), then restart Claude Desktop:

```json
{
"mcpServers": {
"agentailor": {
"command": "npx",
"args": ["-y", "@agentailor/mcp"]
}
}
}
```

</details>

<details>
<summary><strong>Cursor</strong></summary>

Same schema as Claude. Create `.cursor/mcp.json` in your project (or `~/.cursor/mcp.json` for all projects):

```json
{
Expand All @@ -38,7 +61,55 @@ Run the server as a local command — ideal for Claude Desktop. In `claude_deskt
}
```

The repo tools read **public** GitHub data, so no token is required. If you hit GitHub's unauthenticated rate limit (60 requests/hour), pass a token to raise it to 5,000/hour:
</details>

<details>
<summary><strong>VS Code / GitHub Copilot</strong></summary>

Create `.vscode/mcp.json` in your workspace. Note the top-level key is `servers` (not `mcpServers`):

```json
{
"servers": {
"agentailor": {
"command": "npx",
"args": ["-y", "@agentailor/mcp"]
}
}
}
```

</details>

<details>
<summary><strong>OpenAI Codex</strong></summary>

Add to `~/.codex/config.toml`:

```toml
[mcp_servers.agentailor]
command = "npx"
args = ["-y", "@agentailor/mcp"]
```

Or use the CLI: `codex mcp add agentailor -- npx -y @agentailor/mcp`.

</details>

<details>
<summary><strong>Any other MCP client</strong></summary>

Run it as a stdio server with this command:

```
npx -y @agentailor/mcp
```

</details>

#### Raising the GitHub rate limit (optional)

The repo tools read **public** GitHub data, so no token is required. If you hit GitHub's unauthenticated rate limit (60 requests/hour), set a `GITHUB_TOKEN` (any token with public read access) to raise it to 5,000/hour. In a JSON config, add an `env` block to the server entry:

```json
{
Expand All @@ -52,6 +123,8 @@ The repo tools read **public** GitHub data, so no token is required. If you hit
}
```

For Codex, add it under the server's `env` in `config.toml`; for VS Code, add it under the `servers` entry.

### Hosted HTTP (coming soon)

A zero-install, Agentailor-hosted HTTP endpoint is planned — point any streamable-HTTP MCP client at a single URL, nothing to install or run. It isn't live yet; for now use the npx setup above. The endpoint URL will be published on [agentailor.com](https://agentailor.com) when it's ready.
Expand Down
Loading