aimock/docs/mcp/index.html at 0fe22fbe723bfa7f24b931fbcf491dd0b2d7ef31 · CopilotKit/aimock · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
<!doctype html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>MCP Server — aimock</title>
    <link rel="icon" type="image/svg+xml" href="../favicon.svg" />
    <meta
      name="description"
      content="Connect AI agents to aimock documentation via MCP — Claude Code, Claude Desktop, Cursor, Codex, and any Streamable HTTP client."
    />
    <link rel="preconnect" href="https://fonts.googleapis.com" />
    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
    <link
      href="https://fonts.googleapis.com/css2?family=JetBrains+Mono:ital,wght@0,300;0,400;0,500;0,600;0,700;1,400&family=Instrument+Sans:wght@400;500;600;700&display=swap"
      rel="stylesheet"
    />
    <link rel="stylesheet" href="../style.css" />
  </head>
  <body>
    <nav class="top-nav">
      <div class="nav-inner">
        <div style="display: flex; align-items: center; gap: 1rem">
          <button
            class="sidebar-toggle"
            onclick="document.querySelector('.sidebar').classList.toggle('open')"
            aria-label="Toggle sidebar"
          >
            &#9776;
          </button>
          <a href="/" class="nav-brand"> <span class="prompt">$</span> aimock </a>
        </div>
        <ul class="nav-links">
          <li><a href="/">Home</a></li>
          <li><a href="/docs" style="color: var(--accent)">Docs</a></li>
          <li>
            <a href="https://github.com/CopilotKit/aimock" class="gh-link" target="_blank"
              ><svg width="16" height="16" viewBox="0 0 16 16" fill="currentColor">
                <path
                  d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"
                />
              </svg>
              GitHub</a
            >
          </li>
        </ul>
      </div>
    </nav>

    <div class="docs-layout">
      <aside class="sidebar" id="sidebar"></aside>

      <main class="docs-content">
        <h1>MCP Server</h1>
        <p class="lead">
          aimock's documentation and source code are indexed by a
          <a href="https://github.com/CopilotKit/pathfinder" target="_blank">Pathfinder</a>
          instance, giving AI agents semantic search and file exploration via MCP.
        </p>

        <h2>Available Tools</h2>
        <p>
          The MCP server exposes five tools that agents can use to find information about aimock:
        </p>

        <table class="endpoint-table">
          <thead>
            <tr>
              <th>Tool</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td><code>search-docs</code></td>
              <td>
                Semantic search over aimock documentation — guides, API references, provider configs
              </td>
            </tr>
            <tr>
              <td><code>search-code</code></td>
              <td>Semantic search over aimock's TypeScript source — routers, handlers, builders</td>
            </tr>
            <tr>
              <td><code>explore-docs</code></td>
              <td>Browse documentation files with bash commands (find, grep, cat, ls, head)</td>
            </tr>
            <tr>
              <td><code>explore-code</code></td>
              <td>Browse source code files with bash commands</td>
            </tr>
            <tr>
              <td><code>submit-feedback</code></td>
              <td>Report whether search results were helpful to improve quality</td>
            </tr>
          </tbody>
        </table>

        <h2>Connect Your Agent</h2>

        <h3>Claude Code</h3>
        <p>Add via the CLI:</p>
        <div class="code-block">
          <div class="code-block-header">Terminal <span class="lang-tag">bash</span></div>
          <pre><code>claude mcp add aimock-docs --transport http https://mcp.aimock.copilotkit.dev/mcp</code></pre>
        </div>
        <p>Or add to <code>~/.claude/mcp.json</code>:</p>
        <div class="code-block">
          <div class="code-block-header">~/.claude/mcp.json <span class="lang-tag">json</span></div>
          <pre><code>{
  <span class="prop">"mcp-servers"</span>: {
    <span class="prop">"aimock-docs"</span>: {
      <span class="prop">"type"</span>: <span class="str">"http"</span>,
      <span class="prop">"url"</span>: <span class="str">"https://mcp.aimock.copilotkit.dev/mcp"</span>
    }
  }
}</code></pre>
        </div>

        <h3>Claude Desktop</h3>
        <div class="code-block">
          <div class="code-block-header">
            ~/Library/Application Support/Claude/claude_desktop_config.json
            <span class="lang-tag">json</span>
          </div>
          <pre><code>{
  <span class="prop">"mcpServers"</span>: {
    <span class="prop">"aimock-docs"</span>: {
      <span class="prop">"type"</span>: <span class="str">"http"</span>,
      <span class="prop">"url"</span>: <span class="str">"https://mcp.aimock.copilotkit.dev/mcp"</span>
    }
  }
}</code></pre>
        </div>

        <h3>Cursor</h3>
        <div class="code-block">
          <div class="code-block-header">.cursor/mcp.json <span class="lang-tag">json</span></div>
          <pre><code>{
  <span class="prop">"mcpServers"</span>: {
    <span class="prop">"aimock-docs"</span>: {
      <span class="prop">"type"</span>: <span class="str">"http"</span>,
      <span class="prop">"url"</span>: <span class="str">"https://mcp.aimock.copilotkit.dev/mcp"</span>
    }
  }
}</code></pre>
        </div>

        <h3>OpenAI Codex</h3>
        <div class="code-block">
          <div class="code-block-header">codex-mcp.json <span class="lang-tag">json</span></div>
          <pre><code>{
  <span class="prop">"mcpServers"</span>: {
    <span class="prop">"aimock-docs"</span>: {
      <span class="prop">"type"</span>: <span class="str">"http"</span>,
      <span class="prop">"url"</span>: <span class="str">"https://mcp.aimock.copilotkit.dev/mcp"</span>
    }
  }
}</code></pre>
        </div>
        <p>Then run: <code>codex --mcp-config codex-mcp.json</code></p>

        <h3>VS Code (Continue)</h3>
        <div class="code-block">
          <div class="code-block-header">
            ~/.continue/config.json <span class="lang-tag">json</span>
          </div>
          <pre><code>{
  <span class="prop">"mcpServers"</span>: [
    {
      <span class="prop">"name"</span>: <span class="str">"aimock-docs"</span>,
      <span class="prop">"transport"</span>: {
        <span class="prop">"type"</span>: <span class="str">"http"</span>,
        <span class="prop">"url"</span>: <span class="str">"https://mcp.aimock.copilotkit.dev/mcp"</span>
      }
    }
  ]
}</code></pre>
        </div>

        <h3>Generic (Streamable HTTP)</h3>
        <p>Any MCP-compatible client can connect via Streamable HTTP:</p>
        <div class="code-block">
          <div class="code-block-header">Endpoint <span class="lang-tag">text</span></div>
          <pre><code>URL:       https://mcp.aimock.copilotkit.dev/mcp
Transport: Streamable HTTP
Method:    POST</code></pre>
        </div>

        <h2>What Gets Indexed</h2>
        <p>
          The MCP server indexes two sources from the
          <a href="https://github.com/CopilotKit/aimock" target="_blank">aimock repository</a>:
        </p>
        <ul>
          <li>
            <strong>Documentation</strong> — all HTML pages from <code>docs/</code>, chunked for
            semantic search with source URLs back to
            <a href="https://aimock.copilotkit.dev">aimock.copilotkit.dev</a>
          </li>
          <li>
            <strong>Source code</strong> — TypeScript files from <code>src/</code>, excluding tests,
            chunked by logical code blocks
          </li>
        </ul>
        <p>
          The index auto-refreshes daily and on push via GitHub webhooks, so agents always search
          against the latest content.
        </p>

        <h2>Verifying the Connection</h2>
        <p>
          Once connected, your agent should see the aimock tools in its available tools list. Try
          asking your agent:
        </p>
        <ul>
          <li><em>"Search aimock docs for how to mock streaming responses"</em></li>
          <li><em>"Explore the aimock source code for the router implementation"</em></li>
          <li><em>"How do I use fixtures with aimock?"</em></li>
        </ul>
      </main>
      <aside class="page-toc" id="page-toc"></aside>
    </div>
    <footer class="docs-footer">
      <div class="footer-inner">
        <div class="footer-left"><span>$</span> aimock &middot; MIT License</div>
        <ul class="footer-links">
          <li><a href="https://github.com/CopilotKit/aimock" target="_blank">GitHub</a></li>
          <li>
            <a href="https://www.npmjs.com/package/@copilotkit/aimock" target="_blank">npm</a>
          </li>
        </ul>
      </div>
    </footer>
    <script src="../sidebar.js"></script>
    <script src="../cli-tabs.js"></script>
  </body>
</html>