Skip to content

Commit ab8689a

Browse files
Release v1.0.1 — repo polish and icon updates
- Bump version to 1.0.1 in package.json and manifest.json - Update icon-light PNGs with white backgrounds (512, 32, 16) - Add npm version, Node.js, and TypeScript badges to README - Clarify that end users only need Node.js/npm; Bun removed from docs - Add @modelcontextprotocol/sdk to Acknowledgments - Update CLAUDE.md with release/deployment docs, MCPB build steps, file reference - Exclude stray root icon-light.png from MCPB bundle Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 9f1bf08 commit ab8689a

8 files changed

Lines changed: 61 additions & 30 deletions

File tree

.mcpbignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,8 @@ mcpb-packaging-brief.md
1515
bun.lock
1616
Dockerfile
1717

18+
# Stray files
19+
/icon-light.png
20+
1821
# Already bundled or unnecessary
1922
node_modules/.cache/

CLAUDE.md

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44

55
This is the **Local Falcon MCP Server** (`@local-falcon/mcp`), a Model Context Protocol server that wraps the [Local Falcon API](https://docs.localfalcon.com). It enables AI agents to run geo-grid rank tracking scans, retrieve reports, manage campaigns, monitor Google Business Profiles, and analyze competitive positioning across Google Maps, Apple Maps, and AI search platforms.
66

7-
**Package:** `@local-falcon/mcp` (npm)
7+
**Package:** [`@local-falcon/mcp`](https://www.npmjs.com/package/@local-falcon/mcp) (npm)
8+
**Version:** 1.0.1
89
**License:** MIT
9-
**Runtime:** Node.js / Bun
10+
**Runtime:** Node.js 18+
1011
**Language:** TypeScript (strict mode)
1112

1213
## Architecture
@@ -42,10 +43,10 @@ Started via CLI argument to `index.ts`:
4243

4344
| Mode | Command | Description |
4445
|---|---|---|
45-
| `stdio` (default) | `bun run index.ts` or `bun run index.ts stdio` | Standard I/O for local MCP clients |
46-
| `sse` | `bun run index.ts sse` | Server-Sent Events, OAuth 2.1 protected |
47-
| `http` | `bun run index.ts http` | Streamable HTTP, OAuth 2.1 protected |
48-
| `HTTPAndSSE` | `bun run index.ts HTTPAndSSE` | Both HTTP and SSE on same server |
46+
| `stdio` (default) | `npm run start` or `npm run start:stdio` | Standard I/O for local MCP clients |
47+
| `sse` | `npm run start:sse` | Server-Sent Events, OAuth 2.1 protected |
48+
| `http` | `npm run start:http` | Streamable HTTP, OAuth 2.1 protected |
49+
| `HTTPAndSSE` | `npm run start:HTTPAndSSE` | Both HTTP and SSE on same server |
4950

5051
Remote modes (SSE, HTTP) use OAuth 2.1 with PKCE for authentication. The server implements RFC 8414 (Authorization Server Metadata), RFC 9728 (Protected Resource Metadata), and RFC 7591 (Dynamic Client Registration).
5152

@@ -205,15 +206,31 @@ The Local Falcon API has two base URLs used by `localfalcon.ts`:
205206

206207
Public API documentation: [docs.localfalcon.com](https://docs.localfalcon.com)
207208

209+
## Release & Deployment
210+
211+
| Component | Details |
212+
|---|---|
213+
| npm auto-publish | GitHub Action (`.github/workflows/npm-publish.yml`) triggers on GitHub release creation |
214+
| MCPB packaging | `manifest.json` (v0.3 spec) + `.mcpbignore` + `mcpb pack . local-falcon-mcp.mcpb` |
215+
| OAuth 2.1 | Working end-to-end for remote transports (SSE, HTTP). RFC 8414 / RFC 9728 / RFC 7591 |
216+
| SKILL.md | AI client integration skill definition in `skill/` with 3 reference files |
217+
218+
### MCPB Build
219+
```bash
220+
npm run build # Compile TypeScript to dist/
221+
mcpb validate manifest.json # Validate manifest
222+
mcpb pack . local-falcon-mcp.mcpb # Create .mcpb bundle
223+
```
224+
208225
## Development
209226

210227
### Prerequisites
211-
- Node.js 18+ or Bun
228+
- Node.js 18+
212229
- TypeScript 5.8+
213230

214231
### Setup
215232
```bash
216-
npm install # or: bun install
233+
npm install
217234
cp .env.example .env.local
218235
# Add your LOCAL_FALCON_API_KEY to .env.local
219236
```
@@ -270,8 +287,11 @@ npm run docker:run
270287
| `localfalcon.ts` | API client — fetch functions, rate limiter, retry logic, types |
271288
| `oauth/` | OAuth 2.1 implementation (authorization, tokens, PKCE, client registration) |
272289
| `package.json` | Package config, scripts, dependencies |
290+
| `manifest.json` | MCPB Desktop Extension manifest (v0.3 spec) — tools, icons, user_config |
291+
| `.mcpbignore` | Exclusion patterns for MCPB bundle creation |
273292
| `tsconfig.json` | TypeScript compiler configuration |
274293
| `.env.example` | Environment variable template |
275294
| `Dockerfile` | Container build configuration |
276-
| `skill/` | MCP skill definition (SKILL.md) and reference docs for AI client integration |
295+
| `skill/` | MCP skill definition (SKILL.md) and 3 reference docs for AI client integration |
296+
| `.github/workflows/` | npm auto-publish on GitHub release |
277297
| `_spec/` | Internal development specs (gitignored, not published) |

README.md

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@
99
</p>
1010

1111
<p align="center">
12-
<a href="https://github.com/local-falcon/mcp/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a>
12+
<a href="https://www.npmjs.com/package/@local-falcon/mcp"><img src="https://img.shields.io/npm/v/@local-falcon/mcp.svg" alt="npm version"></a>
13+
<a href="https://github.com/local-falcon/mcp/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a>
14+
<a href="https://nodejs.org/"><img src="https://img.shields.io/badge/node-%3E%3D18-brightgreen.svg" alt="Node.js"></a>
15+
<a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/TypeScript-5.8-blue.svg" alt="TypeScript"></a>
1316
<a href="https://www.localfalcon.com"><img src="https://img.shields.io/badge/Local%20Falcon-Website-red" alt="Local Falcon"></a>
1417
<a href="https://docs.localfalcon.com"><img src="https://img.shields.io/badge/API%20Docs-docs.localfalcon.com-green" alt="API Docs"></a>
1518
</p>
@@ -200,30 +203,35 @@ For Windows:
200203

201204
---
202205

203-
## For developers
206+
## For Developers
204207

205-
- Build (necessary to run in local MCP host applications):
208+
> **Note:** End users only need [Node.js](https://nodejs.org/) (LTS) and npm to install and run this server. The instructions below are for contributors and developers working on the source code.
206209
207-
```bash
208-
bun run build
209-
```
210+
### Prerequisites
210211

211-
- Run MCP Inspector:
212-
```bash
213-
bun run inspector
214-
```
212+
- [Node.js](https://nodejs.org/) 18+ (LTS recommended)
213+
- npm (included with Node.js)
215214

216-
- Run MCP Server:
215+
### Build
217216

218-
Run one of the following:
217+
```bash
218+
npm install
219+
npm run build
220+
```
221+
222+
### Run MCP Inspector
223+
224+
```bash
225+
npm run inspector
226+
```
219227

220-
```bash
221-
bun run start
222-
bun run start:sse
223-
bun run start:stdio
224-
```
228+
### Run MCP Server
225229

226-
Note: if sse is not specified, the server will default to stdio.
230+
```bash
231+
npm run start # STDIO mode (default)
232+
npm run start:sse # SSE mode with OAuth
233+
npm run start:http # HTTP mode with OAuth
234+
```
227235

228236

229237
---
@@ -238,4 +246,4 @@ MIT
238246
## Acknowledgments
239247
- [Local Falcon API Documentation](https://docs.localfalcon.com)
240248
- [Model Context Protocol (MCP)](https://github.com/modelcontextprotocol)
241-
- [Bun](https://bun.sh/)
249+
- [@modelcontextprotocol/sdk](https://www.npmjs.com/package/@modelcontextprotocol/sdk) (Anthropic MCP SDK)

assets/icons/icon-light-16.png

-70 Bytes
Loading

assets/icons/icon-light-32.png

-382 Bytes
Loading

assets/icons/icon-light.png

-10.8 KB
Loading

manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"manifest_version": "0.3",
33
"name": "local-falcon-mcp",
44
"display_name": "Local Falcon",
5-
"version": "1.0.0",
5+
"version": "1.0.1",
66
"description": "Monitor and improve visibility across AI search platforms (ChatGPT, Gemini, Grok, Google AI Overviews, AI Mode) and in local search (Google Maps, Apple Maps) with 37 tools for AI visibility tracking, geo-grid rank analysis, competitor intelligence, campaign management, and Google Business Profile monitoring.",
77
"long_description": "An MCP server for the Local Falcon AI Visibility and local SEO platform. Connect Claude to your Local Falcon account to track how businesses appear across AI search results and traditional map platforms.\n\nCapabilities include running geo-grid scans that check visibility from dozens of surrounding coordinates simultaneously, retrieving scan reports with AI-powered analysis, tracking visibility trends over time, managing scheduled campaigns across multiple locations and keywords, monitoring Google Business Profiles for unwanted changes with Falcon Guard, analyzing reviews with sentiment and topic breakdowns, and researching competitors to identify strategic opportunities.\n\nSupported platforms: Google Maps, Apple Maps, Google AI Overviews, Google AI Mode, ChatGPT, Gemini, and Grok.",
88
"author": {

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@local-falcon/mcp",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"description": "An MCP server for the Local Falcon API.",
55
"main": "index.js",
66
"repository": {

0 commit comments

Comments
 (0)