agentleFS
vodolaz095vodolaz095/go-mcp-smtp/AGENTS.md

go-mcp-smtp

AGENTS.md0 starsChanged 3 months agoMITView on GitHub

This document describes the MCP server agents provided by the go-mcp-smtp project. go-mcp-smtp is an MCP (Model Context Protocol) server that enables sending email messages via the SMTP Submission protocol. It provides agents that can be integrated into AI systems to send emails programmatically. Purpose: Check connectivity and availability of the SMTP submission server. Output: - message: Status message indicating server availability Example Usage: Possible Responses: - Success: {"message": "smtp submission server is cooperating"} - Error: {"message": "error checking smtp…

  • 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 32,671 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 repository3 other files it gives its agents.

The file

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

10 rules. About 0 are common, 5 are distinctive, and 5 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 5

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Purpose: Check connectivity and availability of the SMTP submission server.

    line 13
  2. Distinctive:

    Purpose: Run linting on the Go codebase and automatically fix any issues found.

    line 110
  3. Distinctive:

    Verify required tools are available (go, gopls, staticcheck)

    line 113
  4. Very specific:

    Run make lint to identify issues

    line 114
  5. Distinctive:

    Verify fixes resolved all issues

    line 116
  6. Very specific:

    Ensure required tools are available (make tools)

    line 129
  7. Very specific:

    Ensure dependencies are downloaded (make deps)

    line 130
  8. Very specific:

    Run vulnerability scan (make vuln)

    line 131
  9. Very specific:

    Update vulnerable modules using go get

    line 133
  10. Distinctive:

    Purpose: Run unit tests for the project.

    line 143

≈ “Common” is an estimate: at least 1 in 5 of the 41,581 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

go-mcp-smtp Agents

This document describes the MCP server agents provided by the go-mcp-smtp project.

Overview

go-mcp-smtp is an MCP (Model Context Protocol) server that enables sending email messages via the SMTP Submission protocol. It provides agents that can be integrated into AI systems to send emails programmatically.

Available Agents

Ping

Purpose: Check connectivity and availability of the SMTP submission server.

Input: None

Output:

  • message: Status message indicating server availability

Example Usage:

{
  "tool": "ping",
  "input": {}
}

Possible Responses:

  • Success: {"message": "smtp submission server is cooperating"}
  • Error: {"message": "error checking smtp submission server: <error details>"}

SendRawEmail

Purpose: Send a raw email message through the SMTP submission server.

Input:

  • recipients: List of recipients in format "Name email@domain.com" (comma-separated)
  • subject: Subject of the email message (8bit ANSI encoding)
  • body: Message body in plain text without any formatting

Output:

  • message: Status message indicating message acceptance

Example Usage:

{
  "tool": "sendRawEmail",
  "input": {
    "recipients": "John Doe <john@example.com>, Jane Smith <jane@example.com>",
    "subject": "Test Message",
    "body": "This is a test email sent via go-mcp-smtp."
  }
}

Possible Responses:

  • Success: {"message": "message is accepted by submission server"}
  • Error: {"message": "error sending message: <error details>"}

SendMarkDownWithAttachmentsEmail

Purpose: Send a markdown email message through the SMTP submission server with content rendered from markdown and optional attachments.

Input:

  • recipients: List of recipients in RFC 5322 format like "John Doe john.doe@example.com"
  • subject: Subject of the email message (8bit ANSI encoding)
  • markdown: Message body in GitHub flavored markdown format
  • attachments: List of absolute file paths to attachment files (optional)

Output:

  • message: Status message indicating message acceptance

Example Usage:

{
  "tool": "sendMarkDownWithAttachmentsEmail",
  "input": {
    "recipients": "John Doe <john.doe@example.com>",
    "subject": "Hello from Markdown",
    "markdown": "**Hello World!**\n\nThis is a test of markdown rendering.",
    "attachments": ["/path/to/file.pdf"]
  }
}

Possible Responses:

  • Success: {"message": "message is accepted by submission server"}
  • Error: {"message": "error sending message: <error details>"}

Configuration

The MCP server requires configuration via command-line arguments when starting:

  • --network: Network type (tcp, unix, etc.)
  • --address: SMTP server address with port (e.g., smtp.example.org:587)
  • --host: SMTP server hostname
  • --helo: HELO/EHLO hostname
  • --username: SMTP authentication username
  • --password: SMTP authentication password
  • --from: Default sender email address
  • --start_tls: Whether to use STARTTLS (true/false)
  • --verbose: Use verbose mode

See the README.md for a complete configuration example.

Available Skills

lint

Purpose: Run linting on the Go codebase and automatically fix any issues found.

Usage:

  1. Verify required tools are available (go, gopls, staticcheck)
  2. Run make lint to identify issues
  3. Analyze lint output and apply fixes
  4. Verify fixes resolved all issues

Dependencies:

  • Go compiler (go)
  • Go language server (gopls)
  • Staticcheck tool
  • Make build system

vuln-scan

Purpose: Scan the codebase for known vulnerabilities using govulncheck.

Usage:

  1. Ensure required tools are available (make tools)
  2. Ensure dependencies are downloaded (make deps)
  3. Run vulnerability scan (make vuln)
  4. Identify vulnerable modules from the report
  5. Update vulnerable modules using go get
  6. Re-run make deps and make vuln to verify resolution

Dependencies:

  • govulncheck tool
  • Go 1.26+
  • Internet access to fetch vulnerability database

run-tests

Purpose: Run unit tests for the project.

Usage:

  • make test: Run all tests with verbose output
  • make cover: Run tests with coverage reporting
  • make check: Run linting before tests

Prerequisites:

  • Required tools: make tools
  • Dependencies: make deps

Additional Options:

  • make cover: Generate test coverage report
  • make check: Run linting before executing tests

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.