@ls-apis/cli 0.0.4 → 0.0.6

package/README.md

@@ -2,7 +2,7 @@
 
 ### Public APIs Discovery for Humans & Agents
 
-A curated collection of **4,300+ public APIs** with a powerful CLI search tool. Discover, filter, and explore APIs by category, authentication type.
+A curated collection of **4,000+ public APIs** with a powerful CLI search tool. Discover, filter, and explore APIs by category, authentication type.
 
 ## Features
 
@@ -10,6 +10,7 @@ A curated collection of **4,300+ public APIs** with a powerful CLI search tool.
 - **Smart Search** - Filter by query, category, authentication type
 - **Colored Output** - Syntax-highlighted results (use `--no-color` to disable)
 - **Multiple Output Formats** - Text or JSON output
+- **MCP Server** - AI-friendly API search via Model Context Protocol
 - **Extensible Architecture** - Pluggable fetchers for adding new API sources
 - **TypeScript** - Fully typed for better developer experience
 
@@ -131,7 +132,7 @@ A config file is automatically created at `~/.ls-apis` on first run. You can edi
 | `descriptionMaxLength` | 250     | Max chars before truncation |
 | `colors`               | true    | Enable terminal colors      |
 
-The config file is plain JSON. Edit it manually to customize defaults, or delete it to regenerate with built-in values. Uses only Node.js standard library (`os`, `path`, `fs/promises`).
+The config file is plain JSON. Edit it manually to customize defaults, or delete it to regenerate with built-in values.
 
 ### Example Output
 
@@ -152,3 +153,92 @@ Found 2 APIs:
     Sources: publicapis-dev
 ```
 
+## MCP Server
+
+ls-apis includes an [MCP](https://modelcontextprotocol.io) server for AI assistants to search and discover public APIs via natural language.
+
+### Tools
+
+| Tool              | Description                                                 |
+| ----------------- | ----------------------------------------------------------- |
+| `search-apis`     | Search public APIs by query, category, auth type, and limit |
+| `list-categories` | List all API categories with API counts                     |
+| `list-providers`  | List all data providers with API counts                     |
+
+### Resources
+
+| URI                 | Description                           |
+| ------------------- | ------------------------------------- |
+| `apis://data`       | Full aggregated API dataset (JSON)    |
+| `apis://categories` | All API categories with counts (JSON) |
+| `apis://providers`  | All data providers with counts (JSON) |
+| `apis://stats`      | Dataset summary statistics (JSON)     |
+
+### Setup
+
+```bash
+npm install
+```
+
+### Configuration
+
+#### VS Code / GitHub Copilot
+
+Create `.vscode/mcp.json` in your project root:
+
+> VS Code will ask for permission on first run — this is standard for project-local MCP servers. Approve once and it won't prompt again.
+
+```json
+{
+  "servers": {
+    "ls-apis": {
+      "command": "npx",
+      "args": ["tsx", "packages/mcp-server/src/index.ts"],
+      "cwd": "/path/to/ls-apis"
+    }
+  }
+}
+```
+
+> Switch Copilot Chat to **Agent mode** to use MCP tools.
+
+#### Claude Desktop
+
+Edit `claude_desktop_config.json` (`%APPDATA%\Claude\` on Windows, `~/Library/Application Support/Claude/` on macOS):
+
+```json
+{
+  "mcpServers": {
+    "ls-apis": {
+      "command": "npx",
+      "args": ["tsx", "packages/mcp-server/src/index.ts"],
+      "cwd": "/path/to/ls-apis"
+    }
+  }
+}
+```
+
+#### Cursor
+
+Create `.cursor/mcp.json` (project) or `~/.cursor/mcp.json` (global):
+
+```json
+{
+  "mcpServers": {
+    "ls-apis": {
+      "command": "npx",
+      "args": ["tsx", "packages/mcp-server/src/index.ts"],
+      "cwd": "/path/to/ls-apis"
+    }
+  }
+}
+```
+
+### Verification
+
+After configuring, the client should discover the tools and resources listed above. You can also test via CLI:
+
+```bash
+echo '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | npm run mcp
+```
+