{% extends "docs/base.html" %}

{% block docs_content %}
  <div class="mb-4">
    <h1 class="h3 mb-1">ping_user</h1>
    <p class="text-muted mb-0">Send a one-off ping to a user, subject to their ping mention settings.</p>
    <p class="small mt-2 mb-0">Other interfaces: <a href="/docs/api/ping-user">REST API</a> and <a href="/docs/cli/ping-user">CLI <code>ping-user</code></a>.</p>
  </div>

  <div class="card shadow-sm mb-4">
    <div class="card-body">
      <h2 class="h6 text-uppercase text-muted">Parameters</h2>
      <table class="table table-sm mb-0">
        <thead>
          <tr>
            <th>Name</th>
            <th>Type</th>
            <th>Required</th>
            <th>Description</th>
          </tr>
        </thead>
        <tbody>
          <tr>
            <td><code>username</code></td>
            <td>string</td>
            <td>Yes</td>
            <td>The username of the user to ping, or <code>self</code> for the authenticated user.</td>
          </tr>
          <tr>
            <td><code>body</code></td>
            <td>string</td>
            <td>No</td>
            <td>An optional message of at most 240 characters. Omit it to send a bare ping.</td>
          </tr>
        </tbody>
      </table>
    </div>
  </div>

  <div class="card shadow-sm mb-4">
    <div class="card-body">
      <h2 class="h6 text-uppercase text-muted">Example</h2>
      <div class="bg-light border rounded p-3">
        <pre class="mb-0"><code>curl -X POST https://pearing.example/api/v1/mcp \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/call",
    "params": {
      "name": "ping_user",
      "arguments": {
        "username": "alice",
        "body": "Can you take a look at this?"
      }
    }
  }'</code></pre>
      </div>
    </div>
  </div>

  <div class="card shadow-sm">
    <div class="card-body">
      <h2 class="h6 text-uppercase text-muted">Response</h2>
      <p>Returns the created <code>user-mention</code> event as a text content block inside the standard MCP tool result.</p>
      <p>The call fails when the user does not exist, has disabled ping mentions, or only accepts pings from teammates and does not share a team with the caller. A user may always ping themselves.</p>
      <p class="mb-0">The MCP tool shares the <code>api:ping-user</code> rate limit with REST and CLI calls. Rate-limit errors include the number of seconds to wait before retrying.</p>
    </div>
  </div>
{% endblock %}