diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..ede3a55 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,7 @@ +node_modules +dist +.astro +.git +.env +.env.* +!.env.example diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..004823d --- /dev/null +++ b/.env.example @@ -0,0 +1,2 @@ +COMPOSE_PROJECT_NAME=mcwaddams-site +DOMAIN=mcwaddams.mcp.website diff --git a/Caddyfile b/Caddyfile new file mode 100644 index 0000000..cec1847 --- /dev/null +++ b/Caddyfile @@ -0,0 +1,24 @@ +:8080 { + root * /srv + file_server + + handle /health { + respond "OK" 200 + } + + # SPA-style fallback for clean URLs + try_files {path} {path}/ {path}.html /index.html + + # Cache static assets aggressively + @static path *.css *.js *.svg *.png *.webp *.jpg *.jpeg *.gif *.ico *.woff *.woff2 + header @static Cache-Control "public, max-age=31536000, immutable" + + # Security headers + header { + X-Content-Type-Options "nosniff" + X-Frame-Options "DENY" + Referrer-Policy "strict-origin-when-cross-origin" + } + + encode gzip zstd +} diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..7698e4f --- /dev/null +++ b/Dockerfile @@ -0,0 +1,21 @@ +# Stage 1: Build the Astro/Starlight site +FROM node:22-alpine AS build + +WORKDIR /app + +COPY package.json package-lock.json* ./ +RUN npm ci + +COPY . . +RUN npm run build + +# Stage 2: Serve static files with Caddy +FROM caddy:2-alpine + +COPY --from=build /app/dist /srv +COPY Caddyfile /etc/caddy/Caddyfile + +EXPOSE 8080 + +HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \ + CMD wget -qO- http://127.0.0.1:8080/health || exit 1 diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..8c1a521 --- /dev/null +++ b/Makefile @@ -0,0 +1,28 @@ +.PHONY: build up down restart logs status clean + +build: + docker compose build + +up: build + docker compose up -d + @echo "Waiting for container to start..." + @sleep 3 + docker compose logs --tail=20 + +down: + docker compose down + +restart: + docker compose down + docker compose up -d --build + @sleep 3 + docker compose logs --tail=20 + +logs: + docker compose logs -f + +status: + docker compose ps + +clean: + docker compose down --rmi local --volumes diff --git a/astro.config.mjs b/astro.config.mjs index 3f7b3b2..2594d73 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -99,6 +99,7 @@ export default defineConfig({ { label: 'Community', items: [ + { label: 'The Gallery', slug: 'community/gallery', badge: { text: 'New', variant: 'success' } }, { label: 'Feedback', slug: 'community/feedback' }, { label: 'Flair Leaderboard', slug: 'community/leaderboard' }, { label: 'Credits', slug: 'community/credits' }, diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..9b8fccb --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,19 @@ +services: + site: + build: . + restart: unless-stopped + networks: + - caddy + labels: + caddy: ${DOMAIN} + caddy.reverse_proxy: "{{upstreams 8080}}" + healthcheck: + test: ["CMD", "wget", "-qO-", "http://127.0.0.1:8080/health"] + interval: 30s + timeout: 3s + start_period: 5s + retries: 3 + +networks: + caddy: + external: true diff --git a/public/Initech.webp b/public/Initech.webp new file mode 100644 index 0000000..ab2a941 Binary files /dev/null and b/public/Initech.webp differ diff --git a/public/box-of-flair.webp b/public/box-of-flair.webp new file mode 100644 index 0000000..7dbedf8 Binary files /dev/null and b/public/box-of-flair.webp differ diff --git a/public/flair/cinema.svg b/public/flair/cinema.svg new file mode 100644 index 0000000..290ae3a --- /dev/null +++ b/public/flair/cinema.svg @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/public/peter-initech-sign.webp b/public/peter-initech-sign.webp new file mode 100644 index 0000000..d5a196a Binary files /dev/null and b/public/peter-initech-sign.webp differ diff --git a/public/peter-zen.webp b/public/peter-zen.webp new file mode 100644 index 0000000..c620564 Binary files /dev/null and b/public/peter-zen.webp differ diff --git a/src/assets/Initech.webp b/src/assets/Initech.webp new file mode 100644 index 0000000..ab2a941 Binary files /dev/null and b/src/assets/Initech.webp differ diff --git a/src/assets/box-of-flair.webp b/src/assets/box-of-flair.webp new file mode 100644 index 0000000..7dbedf8 Binary files /dev/null and b/src/assets/box-of-flair.webp differ diff --git a/src/assets/peter-initech-sign.webp b/src/assets/peter-initech-sign.webp new file mode 100644 index 0000000..d5a196a Binary files /dev/null and b/src/assets/peter-initech-sign.webp differ diff --git a/src/assets/peter-zen.webp b/src/assets/peter-zen.webp new file mode 100644 index 0000000..c620564 Binary files /dev/null and b/src/assets/peter-zen.webp differ diff --git a/src/content/docs/backstory.mdx b/src/content/docs/backstory.mdx index 06d1f53..179dfb8 100644 --- a/src/content/docs/backstory.mdx +++ b/src/content/docs/backstory.mdx @@ -5,8 +5,6 @@ description: How Milton Waddams became the patron saint of legacy document proce import { Aside } from '@astrojs/starlight/components'; -# The Backstory - > *"I was told I could listen to the radio at a reasonable volume from nine to eleven..."* ## The Relocation diff --git a/src/content/docs/community/credits.mdx b/src/content/docs/community/credits.mdx index 04490fa..8857561 100644 --- a/src/content/docs/community/credits.mdx +++ b/src/content/docs/community/credits.mdx @@ -5,8 +5,6 @@ description: The open source projects and cultural references that make mcwaddam import { Aside, Card, CardGrid, LinkCard } from '@astrojs/starlight/components'; -# Credits & Attributions - > *"It's not just about me and my dream of doing nothing."* mcwaddams stands on the shoulders of giants — both technical and cinematic. @@ -133,6 +131,8 @@ For creating Office Space and giving the tech industry a shared vocabulary for d The hero image — featuring THE actual film slate and red Swingline from production — is courtesy of [Mike Judge on X](https://x.com/MikeJudge). +Additional Office Space screenshots and character images sourced from the [Office Space Wiki](https://officespace.fandom.com/wiki/Office_Space_Wiki). Initech logo from the [Initech wiki page](https://officespace.fandom.com/wiki/Initech). Box of Flair merchandise image from the [Office Space Box of Flair wiki page](https://officespace.fandom.com/wiki/Office_Space_Box_of_Flair). + ### Swingline For actually manufacturing a red stapler after the movie came out. Sometimes life imitates art. (Fun fact: the prop department painted a black stapler red because Swingline didn't make that color in 1999.) diff --git a/src/content/docs/community/feedback.mdx b/src/content/docs/community/feedback.mdx index 9cf49e4..26b1348 100644 --- a/src/content/docs/community/feedback.mdx +++ b/src/content/docs/community/feedback.mdx @@ -5,8 +5,6 @@ description: Found a bug? Have an idea? We want to hear it. import { Aside, Card, CardGrid, LinkCard } from '@astrojs/starlight/components'; -# Feedback - > *"Excuse me, I believe you have my bug report..."* We want to hear from you — bugs, feature requests, or just letting us know what works. diff --git a/src/content/docs/community/gallery.mdx b/src/content/docs/community/gallery.mdx new file mode 100644 index 0000000..3a9f035 --- /dev/null +++ b/src/content/docs/community/gallery.mdx @@ -0,0 +1,212 @@ +--- +title: The Gallery +description: A tribute to the film that inspired it all. +--- + +import { Aside, Card, CardGrid } from '@astrojs/starlight/components'; + +> *"I'd say in a given week I probably only do about fifteen minutes of real, actual work."* + +Welcome to the mcwaddams gallery — a loving tribute to Office Space (1999), the film that understands corporate life better than any management consultant ever could. + +--- + +## The Initech Crew + +
+ +
+ Peter Gibbons +

"I did nothing. I did absolutely nothing, and it was everything I thought it could be."

+ Peter Gibbons +
+ +
+ Peter in his zen state +

"I don't like my job, and I don't think I'm gonna go anymore."

+ Post-hypnotherapy Peter +
+ +
+ Peter surprised at computer +

"I have eight different bosses right now."

+ The moment of realization +
+ +
+ +--- + +## Management + +
+ +
+ Lumbergh at Peter's cubicle +

"Yeahhh, I'm gonna need you to come in on Saturday..."

+ Bill Lumbergh +
+ +
+ The Bobs +

"What would you say... you do here?"

+ The Bobs — efficiency experts +
+ +
+ Management disapproval +

"We're gonna have to go ahead and move you downstairs into Storage B."

+ The look of corporate disappointment +
+ +
+ Lumbergh with cake sign +

"Hello Peter, what's happening?"

+ Passive-aggressive celebration +
+ +
+ +--- + +## The Iconic Scenes + +
+ +
+ The printer destruction scene +

"PC LOAD LETTER? What the f*** does that mean?!"

+ The printer gets what it deserves +
+ +
+ Milton's stapler +

"I believe you have my stapler..."

+ The red Swingline +
+ +
+ The O-Face +

"O-O-O-OHHHHH!"

+ Drew's... moment +
+ +
+ The cake scene +

"Milton, we're gonna need you to move your desk again..."

+ Another office milestone ignored +
+ +
+ +--- + +## Chotchkie's & The Flair + +
+ +
+ Stan the manager +

"We need to talk about your flair."

+ Stan — the flair enforcer +
+ +
+ Box of flair +

"You know, the Nazis had pieces of flair they made the Jews wear."

+ The official flair collection +
+ +
+ Joanna's statement +

"There's my flair."

+ Joanna's final day at Chotchkie's +
+ +
+ Chotchkie's logo +

"Sounds like somebody's got a case of the Mondays."

+ Where dreams go to die +
+ +
+ +--- + +## The Supporting Cast + +
+ +
+ Lawrence +

"Hey Peter, man, check out Channel 9!"

+ Lawrence — the neighbor +
+ +
+ Lawrence on the couch +

"Two chicks at the same time, man."

+ Lawrence's dream +
+ +
+ Nina +

"Uh-oh. Sounds like somebody's got a case of the Mondays."

+ Nina — the cheerful coworker +
+ +
+ Peter, Samir, and Michael Bolton +

"Why should I change? He's the one who sucks."

+ The crew at work +
+ +
+ +--- + +## Initech + +
+ +
+ Initech building +

"Corporate accounts payable, Nina speaking. Just a moment."

+ Initech — where TPS reports are born +
+ +
+ Peter arriving at Initech +

"Every single day of my life has been worse than the day before it."

+ Another day at Initech +
+ +
+ Empty Initech office +

"I'd like to move us right along to a Peter Gibbons."

+ The cubicle farm +
+ +
+ Milton's stapler recovered +

"I could set the building on fire..."

+ The stapler survived +
+ +
+ +--- + + + +
+ +*"I don't like my job, and I don't think I'm gonna go anymore."* + +
+ +— Peter Gibbons, speaking for all of us + +
diff --git a/src/content/docs/community/leaderboard.mdx b/src/content/docs/community/leaderboard.mdx index 39fd86a..1f7fa4a 100644 --- a/src/content/docs/community/leaderboard.mdx +++ b/src/content/docs/community/leaderboard.mdx @@ -5,8 +5,6 @@ description: Who's got the most pieces of documentation flair? import { Aside, Card, CardGrid } from '@astrojs/starlight/components'; -# Flair Leaderboard -
Chotchkie's Bar & Grill
@@ -19,46 +17,49 @@ We don't require 37 pieces of flair like Brian. Just the minimum — but we enco ## Your Collection -Click the **flair counter** in the bottom-right corner of any page to see your collection. Badges are earned by spending 3+ seconds reading each page. +Click the **flair counter** in the bottom-right corner of any page to see your collection. Badges are earned by spending 15+ seconds reading each page. -## Available Flair (12 Badges) +## Available Flair (13 Badges) - - Visit the homepage + + Start your mcwaddams journey (homepage) - Read the backstory + Learn about Milton and the legacy documents - Complete installation + Successfully install mcwaddams - Finish quick start + Complete the quick start guide - Browse tools reference + Read the complete tools reference - Study architecture + Understand the architecture - - Check test dashboard + + Check the test dashboard - - Survive torture tests + + Witness the torture test results - - View leaderboard + + Find the credits and attributions - - Read the credits + + Complete your first extraction tutorial - - Learn legacy formats + + Master table extraction - - Use hosted MCP + + Discover the flair leaderboard + + + Explore the Office Space gallery @@ -66,7 +67,7 @@ Click the **flair counter** in the bottom-right corner of any page to see your c ## The Goal -Collect all 12 pieces of flair. Brian from accounting has 37, but we only ask for the minimum. +Collect all 13 pieces of flair. Brian from accounting has 37, but we only ask for the minimum. -## Using with URLs +## Uploading Documents -The hosted server can process documents from URLs directly: +The hosted server cannot access files on your local machine. Instead, you have two options: + +### Option 1: URL Reference + +If your document is already hosted online: ```python # Extract text from a public document @@ -95,7 +97,77 @@ result = await session.call_tool("extract_text", { }) ``` -This is particularly useful for processing documents already hosted online. +### Option 2: Base64 Upload + +For local files, encode them as base64 and pass via `file_content`: + + + + ```python + import base64 + from pathlib import Path + + # Read and encode your document + doc_path = Path("my-report.docx") + file_content = base64.b64encode(doc_path.read_bytes()).decode("utf-8") + + # Call the tool with file_content + result = await session.call_tool("extract_text", { + "file_path": "my-report.docx", # Used for extension detection + "file_content": file_content + }) + ``` + + + ```javascript + import { readFileSync } from 'fs'; + + // Read and encode your document + const docBuffer = readFileSync('my-report.docx'); + const fileContent = docBuffer.toString('base64'); + + // Call the tool with file_content + const result = await session.callTool("extract_text", { + file_path: "my-report.docx", // Used for extension detection + file_content: fileContent + }); + ``` + + + ```bash + # Encode document to base64 + FILE_CONTENT=$(base64 -w 0 my-report.docx) + + # Call via HTTP (simplified example) + curl -X POST https://mcwaddams.l.supported.systems/mcp \ + -H "Content-Type: application/json" \ + -d "{ + \"method\": \"tools/call\", + \"params\": { + \"name\": \"extract_text\", + \"arguments\": { + \"file_path\": \"my-report.docx\", + \"file_content\": \"$FILE_CONTENT\" + } + } + }" + ``` + + + + + +### All Tools Support Upload + +Every tool that accepts `file_path` also accepts `file_content`: + +- `extract_text` - Extract text with base64 upload +- `extract_images` - Extract images with base64 upload +- `convert_to_markdown` - Convert Word docs to Markdown +- `analyze_excel_data` - Analyze uploaded spreadsheets +- And all other document tools... ## Self-Hosting @@ -111,10 +183,16 @@ services: - MCP_TRANSPORT=streamable-http - MCP_HOST=0.0.0.0 - MCP_PORT=8000 + # Enable local file access (disabled by default for security) + # - MCP_ALLOW_LOCAL_FILES=true ports: - "8000:8000" ``` + + ### With Caddy Reverse Proxy Clone the repo and use our docker-compose with caddy-docker-proxy labels: diff --git a/src/content/docs/how-to/pagination.mdx b/src/content/docs/how-to/pagination.mdx index 16bd995..4ca46ac 100644 --- a/src/content/docs/how-to/pagination.mdx +++ b/src/content/docs/how-to/pagination.mdx @@ -5,8 +5,6 @@ description: Work with documents that exceed token limits. import { Aside } from '@astrojs/starlight/components'; -# Handle Pagination - > *"Yeah, I'm gonna need you to go ahead and come in on Saturday for page 2..."* Documents over 25,000 tokens are automatically paginated. Use cursors to fetch subsequent pages. diff --git a/src/content/docs/how-to/url-processing.mdx b/src/content/docs/how-to/url-processing.mdx index 9e1a65c..5acda88 100644 --- a/src/content/docs/how-to/url-processing.mdx +++ b/src/content/docs/how-to/url-processing.mdx @@ -5,8 +5,6 @@ description: Extract documents directly from HTTP/HTTPS URLs. import { Aside } from '@astrojs/starlight/components'; -# Process URLs - > *"We fixed the glitch... by caching the download."* All tools accept HTTP/HTTPS URLs directly. Files are cached for 1 hour. diff --git a/src/content/docs/installation.mdx b/src/content/docs/installation.mdx index afdd7da..df9266c 100644 --- a/src/content/docs/installation.mdx +++ b/src/content/docs/installation.mdx @@ -5,8 +5,6 @@ description: Get mcwaddams up and running in under a minute. import { Tabs, TabItem, Aside, Steps } from '@astrojs/starlight/components'; -# Installation - > *"PC Load Letter? What the f*** does that mean?"* Don't worry. This is simpler than fixing the printer. diff --git a/src/content/docs/quickstart.mdx b/src/content/docs/quickstart.mdx index 6118774..39232e5 100644 --- a/src/content/docs/quickstart.mdx +++ b/src/content/docs/quickstart.mdx @@ -5,8 +5,6 @@ description: Extract your first document in 60 seconds. import { Aside, Steps, Code } from '@astrojs/starlight/components'; -# Quick Start - > *"I'll be honest with you, I love his music. I do. I'm a Michael Bolton fan."* Let's get you extracting documents faster than you can say "TPS report cover sheet." diff --git a/src/content/docs/reference/excel-tools.mdx b/src/content/docs/reference/excel-tools.mdx index 8924352..39583b3 100644 --- a/src/content/docs/reference/excel-tools.mdx +++ b/src/content/docs/reference/excel-tools.mdx @@ -5,8 +5,6 @@ description: Specialized tools for Excel spreadsheet processing. import { Aside } from '@astrojs/starlight/components'; -# Excel Tools - These 3 tools are specialized for `.xlsx`, `.xls`, and `.csv` files. ## analyze_excel_data diff --git a/src/content/docs/reference/formats.mdx b/src/content/docs/reference/formats.mdx index 9a2b75e..806ee9b 100644 --- a/src/content/docs/reference/formats.mdx +++ b/src/content/docs/reference/formats.mdx @@ -5,8 +5,6 @@ description: Complete list of supported Office document formats. import { Aside } from '@astrojs/starlight/components'; -# Format Support - mcwaddams supports all major Microsoft Office formats, both modern and legacy. ## Modern Formats (2007+) diff --git a/src/content/docs/reference/resources.mdx b/src/content/docs/reference/resources.mdx index ea31aed..68d85f8 100644 --- a/src/content/docs/reference/resources.mdx +++ b/src/content/docs/reference/resources.mdx @@ -5,8 +5,6 @@ description: Resource URIs for on-demand document access. import { Aside } from '@astrojs/starlight/components'; -# MCP Resources - After indexing a document, access content via MCP resource URIs. ## Resource URI Schemes diff --git a/src/content/docs/reference/tools.mdx b/src/content/docs/reference/tools.mdx index cb56302..bb4d1f2 100644 --- a/src/content/docs/reference/tools.mdx +++ b/src/content/docs/reference/tools.mdx @@ -5,8 +5,6 @@ description: Complete reference for all 20 mcwaddams MCP tools. import { Aside, Badge, Tabs, TabItem, Card, CardGrid } from '@astrojs/starlight/components'; -# All Tools Reference - > *"I'm going to need you to go ahead and read the documentation..."* mcwaddams provides **20 tools** organized into three categories. Each tool follows the same pattern: pass a file path (local or URL), get structured data back. diff --git a/src/content/docs/reference/universal-tools.mdx b/src/content/docs/reference/universal-tools.mdx index 8ce700c..e425cf5 100644 --- a/src/content/docs/reference/universal-tools.mdx +++ b/src/content/docs/reference/universal-tools.mdx @@ -5,8 +5,6 @@ description: Tools that work across all Office document formats. import { Aside } from '@astrojs/starlight/components'; -# Universal Tools - These 7 tools work with all supported formats: `.docx`, `.doc`, `.xlsx`, `.xls`, `.pptx`, `.ppt`, `.csv`. ## extract_text diff --git a/src/content/docs/reference/word-tools.mdx b/src/content/docs/reference/word-tools.mdx index beb7cbc..8cc286e 100644 --- a/src/content/docs/reference/word-tools.mdx +++ b/src/content/docs/reference/word-tools.mdx @@ -5,8 +5,6 @@ description: Specialized tools for Word document processing. import { Aside } from '@astrojs/starlight/components'; -# Word Tools - These 10 tools are specialized for `.docx` and `.doc` files. ## convert_to_markdown diff --git a/src/content/docs/tps/coverage.mdx b/src/content/docs/tps/coverage.mdx index 0f144c6..e599b3d 100644 --- a/src/content/docs/tps/coverage.mdx +++ b/src/content/docs/tps/coverage.mdx @@ -5,8 +5,6 @@ description: Test coverage philosophy and metrics. import { Aside } from '@astrojs/starlight/components'; -# Coverage Report - > *"Looks like you've been missing a lot of work lately."* > *"I wouldn't say I've been missing it, Bob."* diff --git a/src/content/docs/tps/dashboard.mdx b/src/content/docs/tps/dashboard.mdx index 0c54c82..544c1f5 100644 --- a/src/content/docs/tps/dashboard.mdx +++ b/src/content/docs/tps/dashboard.mdx @@ -5,8 +5,6 @@ description: "Did you get the memo about the TPS reports?" import { Aside, Badge, Card, CardGrid } from '@astrojs/starlight/components'; -# TPS Reports: Test Dashboard - > *"Yeah, I'm gonna need you to go ahead and come in on Saturday..."*