Initial mcwaddams documentation site
Astro + Starlight documentation site for mcwaddams MCP server. Features: - Diátaxis documentation structure (tutorials, how-to, reference, explanation) - Office Space theming (Milton Waddams, TPS Reports, red Swingline) - 29 documentation pages covering all 20 tools - TPS Reports section for test results - Flair gamification config (pieces of documentation flair) - Custom CSS with Office Space color scheme Structure: - Getting Started: backstory, installation, quickstart - Tutorials: first extraction, legacy formats, indexing, resources - How-To: tables, Excel analysis, markdown, pagination, URLs - Reference: all tools, universal/word/excel tools, MCP resources, formats - Explanation: architecture, mixins, fallbacks, resource system - TPS Reports: dashboard, coverage, torture tests - Community: credits, feedback, leaderboard
This commit is contained in:
commit
32b41f79d9
42 changed files with 10513 additions and 0 deletions
34
src/content/docs/tutorials/indexing.mdx
Normal file
34
src/content/docs/tutorials/indexing.mdx
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
title: Indexing Large Documents
|
||||
description: Efficiently access huge documents without loading everything at once.
|
||||
---
|
||||
|
||||
import { Aside } from '@astrojs/starlight/components';
|
||||
|
||||
# Indexing Large Documents
|
||||
|
||||
> *"It's not that I'm lazy, it's that I just don't care about loading 500 pages at once."*
|
||||
|
||||
For documents over 25,000 tokens, the indexing system enables on-demand fetching through MCP resources.
|
||||
|
||||
<Aside type="caution" title="Coming Soon">
|
||||
Detailed indexing tutorial in progress.
|
||||
</Aside>
|
||||
|
||||
## Quick Example
|
||||
|
||||
```python
|
||||
# Index once
|
||||
result = await index_document("huge-novel.docx")
|
||||
# Returns: {"doc_id": "abc123", "resources": {...}}
|
||||
|
||||
# Fetch chapters on demand
|
||||
# chapter://abc123/1 → Chapter 1
|
||||
# chapter://abc123/1.md → Chapter 1 as Markdown
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
<div style="text-align: center; margin-top: 2rem; font-style: italic; opacity: 0.7;">
|
||||
*Full tutorial coming soon.*
|
||||
</div>
|
||||
Loading…
Add table
Add a link
Reference in a new issue