Skip to main content

MCP server for raw TCP socket access with buffer management and triggers

Project description

TCP Socket MCP Server

A Model Context Protocol (MCP) server that provides raw TCP socket access, enabling AI models to interact directly with network services using raw TCP Sockets. Supports multiple concurrent connections, buffering of response data and triggering automatic responses.

Demo

Demo 1 Interrogating a device to figure out what it is

Demo 2 Sending data to the device

Output Example Sample output from TCP interactions

Installation & Setup

Install from PyPI

# Install with pip
pip install TcpSocketMCP

# Install with uv (recommended)
uv add TcpSocketMCP

# Add to Claude Code (recommended)
claude mcp add rawtcp -- uvx TcpSocketMCP

For Claude Desktop

Add the server to your Claude Desktop configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%\Claude\claude_desktop_config.json

Option 1: Using installed package (recommended)

{
  "mcpServers": {
    "tcp-socket": {
      "command": "TcpSocketMCP",
      "env": {}
    }
  }
}

Option 2: From source

{
  "mcpServers": {
    "tcp-socket": {
      "command": "python",
      "args": ["/path/to/tcp-socket-mcp/run.py"],
      "env": {}
    }
  }
}

Development Setup

# Clone the repository
git clone https://github.com/kaseyk/tcp-socket-mcp.git
cd tcp-socket-mcp

# Install with uv (recommended)
uv pip install -e .

# Or install with pip
pip install -e .

# Run the server directly
python run.py

# Or use the command
TcpSocketMCP

Available Tools

Once configured via MCP, the following tools become available to the AI model:

Core Connection Tools

tcp_connect

Opens a TCP connection to any host:port

  • Returns a connection_id for subsequent operations
  • Supports custom connection_id for pre-registered triggers
  • Example: tcp_connect("example.com", 80)

tcp_send

Sends data over an established connection

  • Encoding options: utf-8, hex (recommended for binary), base64
  • Hex format: Plain pairs like "48656C6C6F" for "Hello"
  • Terminator: Optional hex suffix like "0D0A" for CRLF

tcp_read_buffer

Reads received data from connection buffer

  • Data may not be immediately available after sending
  • Buffer stores all received data until cleared
  • Supports index/count for partial reads
  • Format options: utf-8, hex, base64

tcp_disconnect

Closes connection and frees resources

  • Always close connections when done
  • All triggers automatically removed

Advanced Features

tcp_set_trigger

Sets automatic responses for pattern matches

  • Pre-registration: Set triggers before connecting for immediate activation
  • Supports regex patterns with capture groups ($1, $2)
  • Response fires automatically when pattern matches
  • Perfect for protocol handshakes (IRC PING/PONG, etc.)

tcp_connect_and_send

Combines connect + send in one atomic operation

  • Essential for time-sensitive protocols
  • Useful for immediate handshakes or banner grabbing
  • Returns connection_id for further operations

Utility Tools

  • tcp_list_connections: View all active connections with statistics
  • tcp_connection_info: Get detailed info about specific connection
  • tcp_buffer_info: Check buffer statistics without reading data
  • tcp_clear_buffer: Clear received data from buffer
  • tcp_remove_trigger: Remove specific auto-response trigger

Usage Examples

Basic TCP Communication

# Connect to a service
conn_id = tcp_connect("example.com", 80)

# Send data (hex encoding recommended for protocols)
tcp_send(conn_id, "474554202F20485454502F312E310D0A", encoding="hex")  # GET / HTTP/1.1\r\n

# Read response (may need to wait for data)
response = tcp_read_buffer(conn_id)

# Clean up
tcp_disconnect(conn_id)

Automated Protocol Handling

# Pre-register trigger for IRC PING/PONG
tcp_set_trigger("irc-conn", "ping-handler", "^PING :(.+)", "PONG :$1\r\n")

# Connect with pre-registered triggers
tcp_connect("irc.server.com", 6667, connection_id="irc-conn")
# PING responses now happen automatically!

Working with Binary Protocols

# Use hex encoding for precise byte control
tcp_send(conn_id, "0001000400000001", encoding="hex")  # Binary protocol header

# Read response in hex for analysis
response = tcp_read_buffer(conn_id, format="hex")

Important Notes

Hex Encoding for Line Endings

Many text protocols (HTTP, SMTP, IRC) require specific line endings. Use hex encoding to avoid JSON escaping issues:

# Common hex sequences:
# 0D0A     = \r\n (CRLF) - HTTP, SMTP, IRC
# 0A       = \n (LF) - Unix line ending
# 0D0A0D0A = \r\n\r\n - HTTP header terminator
# 00       = Null byte - Binary protocols

Timing Considerations

  • Network responses aren't instant - use tcp_buffer_info to check for data
  • Consider implementing retry logic with small delays
  • Buffer accumulates all received data - clear when needed

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tcpsocketmcp-0.1.3.tar.gz (6.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tcpsocketmcp-0.1.3-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

Details for the file tcpsocketmcp-0.1.3.tar.gz.

File metadata

  • Download URL: tcpsocketmcp-0.1.3.tar.gz
  • Upload date:
  • Size: 6.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tcpsocketmcp-0.1.3.tar.gz
Algorithm Hash digest
SHA256 dc044cf2496c9a5f4d17d82b19d72a390c1bf778c287419c4466f012c9ab2207
MD5 fcf3abe5241d436d241aadf2391e72f1
BLAKE2b-256 f3df36c28026ee1a4a2685d40531ea01203f55958de3a51095ef27e18ecf328b

See more details on using hashes here.

Provenance

The following attestation bundles were made for tcpsocketmcp-0.1.3.tar.gz:

Publisher: publish.yml on SpaceyKasey/TcpSocketMCP

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tcpsocketmcp-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: tcpsocketmcp-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 13.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tcpsocketmcp-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9153d83fcbcb92b9922360fb16c7345731ab3e6f9c1c6ff137f2d680e4377431
MD5 a8802059c87a7eda3b178c1a8253e891
BLAKE2b-256 f70237a81e4a549f2e5a193a5cb5ad47091f66f329c85904e80e638f166989ff

See more details on using hashes here.

Provenance

The following attestation bundles were made for tcpsocketmcp-0.1.3-py3-none-any.whl:

Publisher: publish.yml on SpaceyKasey/TcpSocketMCP

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page