Skip to content

docs: document MCP Inspector #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 27 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
# Algolia NodeJS MCP implementation

- [Running the MCP Server (Mac Only)](#running-the-mcp-server-mac-only)
- [What can I ask for?](#what-can-i-ask-for)
- [Account](#account)
- [Apps](#apps)
- [Search](#search)
- [AB Testing](#ab-testing)
- [Analytics](#analytics)
- [Monitoring](#monitoring)
- [CLI options](#cli-options)
- [List available commands](#list-available-commands)
- [Server options](#server-options)
- [Setup dev environment](#setup-dev-environment)
- [Algolia NodeJS MCP implementation](#algolia-nodejs-mcp-implementation)
- [Running the MCP Server (Mac Only)](#running-the-mcp-server-mac-only)
- [What can I ask for?](#what-can-i-ask-for)
- [Account](#account)
- [Apps](#apps)
- [Search](#search)
- [AB Testing](#ab-testing)
- [Analytics](#analytics)
- [Monitoring](#monitoring)
- [CLI options](#cli-options)
- [List available commands](#list-available-commands)
- [Server options](#server-options)
- [Setup dev environment](#setup-dev-environment)
- [Testing and debugging](#testing-and-debugging)

## Running the MCP Server (Mac Only)

Expand Down Expand Up @@ -134,3 +136,16 @@ And then you'll need to configure Claude Desktop like so:

> [!TIP]
> You'll need to restart Claude Desktop every time you make a modification.

## Testing and debugging

You can test and debug tools using the [MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector).

Navigate to the respository and run the `debug` script:

```sh
cd path/to/mcp-node
npm run debug
```

Then go to http://127.0.0.1:6274/ and click **Connect** to start the server.
Loading