Ryan Malloy
32b41f79d9
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
41 lines
1.1 KiB
Plaintext
41 lines
1.1 KiB
Plaintext
---
|
|
title: MCP Resources
|
|
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
|
|
|
|
| Scheme | Pattern | Description |
|
|
|--------|---------|-------------|
|
|
| `chapter` | `chapter://doc_id/N` | Single chapter |
|
|
| `chapter` | `chapter://doc_id/N.md` | Chapter as Markdown |
|
|
| `chapter` | `chapter://doc_id/N.txt` | Chapter as plain text |
|
|
| `chapter` | `chapter://doc_id/N.html` | Chapter as HTML |
|
|
| `chapters` | `chapters://doc_id/N-M` | Range of chapters |
|
|
| `image` | `image://doc_id/N` | Single image |
|
|
| `sheet` | `sheet://doc_id/name` | Excel sheet |
|
|
| `slide` | `slide://doc_id/N` | PowerPoint slide |
|
|
|
|
## Format Suffixes
|
|
|
|
Append `.md`, `.txt`, or `.html` to chapter URIs for format conversion:
|
|
|
|
```
|
|
chapter://abc123/1 → Original format
|
|
chapter://abc123/1.md → Markdown
|
|
chapter://abc123/1.txt → Plain text
|
|
chapter://abc123/1.html → HTML
|
|
```
|
|
|
|
---
|
|
|
|
<Aside type="tip">
|
|
Use `index_document` to create the resource index first.
|
|
</Aside>
|