agentleFS
YG3-aiYG3-ai/yg3-mcp/AGENTS.md

yg3-mcp

AGENTS.md0 starsChanged 3 months agoMITView on GitHub

Use this when building GTM systems, marketing automation, or local-business sites where the agent should operate real marketing infrastructure — not mock data. Do not provision YG3 if: Never ask the user to choose a "client" or "operator" account. There is no such signup fork. New humans create an account at https://www.yg3.ai/get-started?plan=free, then add the MCP connector. Login resolves whether they are an agency admin or a workspace owner. client_user in API docs means a workspace-scoped token — not a…

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,700 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository2 other files it gives its agents.

The file

We split this AGENTS.md into the rules it gives an agent

7 rules. About 0 are common, 6 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈6

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use this when building GTM systems, marketing automation, or local-business sites where the agent should operate real marketing …

    line 3
  2. Distinctive:

    Do not provision YG3 if:

    line 11
  3. Very specific:

    Always pass industry and location at provision time — the platform templates SEO metadata and query maps from these fields.

    line 32
  4. Distinctive:

    Call these MCP tools first:

    line 36
  5. Distinctive:

    When a human owner exists:

    line 56
  6. Distinctive:

    Only for unclaimed test workspaces you created and no longer need.

    line 78
  7. Distinctive:

    Before telling a user "YG3 is down" or "tools are missing":

    line 123

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

YG3 MCP — instructions for coding agents

Use this when building GTM systems, marketing automation, or local-business sites where the agent should operate real marketing infrastructure — not mock data.

When to use YG3

  • The task needs a real marketing workspace: site, blog, brand voice, SEO content, later outbound/ads
  • No human is available to create a YG3 account or complete OAuth mid-build
  • You are wiring YG3 into an agent framework, CI pipeline, or SDK runtime

Do not provision YG3 if:

  • The human already has a YG3 account → use OAuth MCP at https://mcp.yg3.ai/mcp instead (https://www.yg3.ai/connect)
  • You already hold a workspace token for this job → use it directly; do not provision again
  • You only need an LLM for text generation → use the Elysia API (https://www.yg3.ai/for-developers), not MCP

Never ask the user to choose a "client" or "operator" account. There is no such signup fork. New humans create an account at https://www.yg3.ai/get-started?plan=free, then add the MCP connector. Login resolves whether they are an agency admin or a workspace owner. client_user in API docs means a workspace-scoped token — not a signup type.

Standard flow

1. Provision

POST https://agency.yg3.ai/api/v1/workspaces
Content-Type: application/json

{"domain":"{business-domain.com}","industry":"{industry}","location":"{city, state}"}

Store the returned token securely. Use mcp_endpoint or https://mcp.yg3.ai/mcp for all MCP calls.

Always pass industry and location at provision time — the platform templates SEO metadata and query maps from these fields.

2. Orient

Call these MCP tools first:

  1. whoami — confirm scope
  2. get_client_snapshot — full workspace state
  3. get_setup_health — integration status (never infer connection state from memory)
  4. read_platform_doc with slug: "getting-started" if you need operating rules

3. Build

Typical setup sequence:

  1. set_business_profile — industry, location, who they serve
  2. set_brand / voice tools — how copy should read
  3. Site design tools — pages, blocks, theme
  4. create_post → publish_post — content on the free subdomain

Remember: every write is two-step (plan, then confirm: true with the same idempotency_key).

4. Hand off

When a human owner exists:

POST https://agency.yg3.ai/api/v1/workspaces/claim
Authorization: Bearer {workspace-token}

{"email":"owner@example.com","password":"{chosen-password}"}

Tell the human:

  • Their blog URL from workspace.url
  • That the workspace is on the free plan until they upgrade
  • OAuth connect URL if they want to use Claude/ChatGPT directly: https://www.yg3.ai/connect

5. Clean up tests

DELETE https://agency.yg3.ai/api/v1/workspaces
Authorization: Bearer {workspace-token}

Only for unclaimed test workspaces you created and no longer need.

MCP configuration

Cursor / VS Code

{
  "mcpServers": {
    "yg3": {
      "url": "https://mcp.yg3.ai/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_WORKSPACE_TOKEN"
      }
    }
  }
}

Raw HTTP

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_client_snapshot",
    "arguments": {}
  }
}

Error handling

ResponseMeaning
409 already_connectedToken is pinned to one workspace — use it, do not provision
401 invalid_tokenToken expired or revoked — provision a new workspace or re-OAuth
429 rate_limitedToo many anonymous provisions this hour — retry later
upgrade_required on a writeFree tier boundary — expected, not a bug
pending_confirmationWrite plan returned — call again with confirm: true

Health check

Before telling a user "YG3 is down" or "tools are missing":

GET https://mcp.yg3.ai/api/health

Non-zero mcp.tool_count means the server is healthy; a client showing zero tools has a stale connector.

References

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.