Skip to content

Commit 8e360bf

Browse files
authored
Mcp overview update (#1874)
* v1.30.0 * docs: add svelte and flowbite-svelte claude.md example * chore: format, lint, check, e2e
1 parent 2de7d30 commit 8e360bf

File tree

2 files changed

+82
-1
lines changed

2 files changed

+82
-1
lines changed

src/routes/docs/extend/step-indicator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The step indicator supports clickable navigation by default. Click on any step t
4545

4646
Here's a complete example of using the step indicator with a multi-step form. Users can click on any completed step to go back and edit their information.
4747

48-
```svelte example class="max-w-2xl"
48+
```svelte example class="max-w-2xl h-[430px]"
4949
{#include ClickableForm.svelte}
5050
```
5151

src/routes/docs/mcp/overview.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,84 @@ After calling findComponent, use this tool to fetch the complete documentation i
4141
Performs full-text search across all Flowbite-Svelte documentation.
4242
Use this when you need to find specific information that might span multiple components or when the user asks about features or patterns.
4343
```
44+
45+
## CLAUDE.md for Svelte and Flowbite-Svelte
46+
47+
Use the following example for Svelte and Flowbite-Svelte:
48+
```md
49+
# Claude MCP Server Documentation
50+
51+
This project uses multiple MCP servers to provide comprehensive documentation access.
52+
53+
## Available MCP Servers
54+
55+
### Svelte MCP Server
56+
57+
You have access to comprehensive Svelte 5 and SvelteKit documentation. Here's how to use the available tools effectively:
58+
59+
#### Available Tools:
60+
61+
**1. list-sections**
62+
- Use this FIRST to discover all available documentation sections
63+
- Returns a structured list with titles, use_cases, and paths
64+
- When asked about Svelte or SvelteKit topics, ALWAYS use this tool at the start to find relevant sections
65+
66+
**2. get-documentation**
67+
- Retrieves full documentation content for specific sections
68+
- Accepts single or multiple sections
69+
- After calling list-sections, you MUST analyze the returned documentation (especially the use_cases field) and then fetch ALL relevant sections for the user's task
70+
71+
**3. svelte-autofixer**
72+
- Analyzes Svelte code and returns issues and suggestions
73+
- You MUST use this tool whenever writing Svelte code before sending it to the user
74+
- Keep calling it until no issues or suggestions are returned
75+
76+
**4. playground-link**
77+
- Generates a Svelte Playground link with the provided code
78+
- After completing the code, ask the user if they want a playground link
79+
- NEVER call this if code was written to files in their project
80+
81+
### Flowbite-Svelte MCP Server
82+
83+
You have access to comprehensive Flowbite-Svelte component documentation. Here's how to use the available tools effectively:
84+
85+
#### Available Tools:
86+
87+
**1. findComponent**
88+
- Use this FIRST to discover components by name or category
89+
- Returns component information including the documentation path
90+
- When asked about Flowbite-Svelte components, ALWAYS use this tool to locate the correct component before fetching documentation
91+
- Example queries: 'Button', 'CardPlaceholder', 'form checkbox'
92+
93+
**2. getComponentList**
94+
- Lists all available Flowbite-Svelte components with their categories
95+
- Use this to discover what components are available or to help users explore component options
96+
97+
**3. getComponentDoc**
98+
- Retrieves full documentation content for a specific component
99+
- Accepts the component path found using findComponent
100+
- After calling findComponent, use this tool to fetch complete documentation including usage examples, props, and best practices
101+
102+
**4. searchDocs**
103+
- Performs full-text search across all Flowbite-Svelte documentation
104+
- Use this when you need to find specific information that might span multiple components or when the user asks about features or patterns
105+
106+
## Workflow Guidelines
107+
108+
### When building Svelte components with Flowbite-Svelte:
109+
110+
1. **Start with Svelte documentation**: Use `list-sections` to understand which Svelte concepts are needed
111+
2. **Fetch relevant Svelte docs**: Use `get-documentation` to get all necessary Svelte sections
112+
3. **Find Flowbite-Svelte components**: Use `findComponent` to locate the UI components needed
113+
4. **Get component details**: Use `getComponentDoc` to fetch usage examples and props
114+
5. **Write the code**: Combine Svelte patterns with Flowbite-Svelte components
115+
6. **Validate the code**: Use `svelte-autofixer` to check for issues
116+
7. **Offer playground**: Ask if the user wants a playground link (only if not writing to files)
117+
118+
### Best Practices:
119+
120+
- Always prioritize Svelte 5 runes and modern patterns
121+
- Use Flowbite-Svelte components for consistent UI design
122+
- Validate all code with svelte-autofixer before delivering
123+
- Keep documentation lookups efficient by fetching multiple sections at once
124+
```

0 commit comments

Comments
 (0)