Skip to content

Commit de02a31

Browse files
committed
docs
1 parent 7711177 commit de02a31

2 files changed

Lines changed: 67 additions & 0 deletions

File tree

docs/config.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@
2121
"label": "Quick Start (Maintainers)",
2222
"to": "getting-started/quick-start-maintainers"
2323
},
24+
{
25+
"label": "MCP Server Quick Start",
26+
"to": "getting-started/mcp-server"
27+
},
2428
{
2529
"label": "Get Listed on the Registry",
2630
"to": "registry"

docs/getting-started/mcp-server.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: MCP Server Quick Start
3+
id: mcp-server
4+
---
5+
6+
`@tanstack/intent-mcp` lets MCP-compatible agents discover and load Intent skills from your installed packages.
7+
8+
Use it when your agent supports MCP and you want package skills available without copying `intent list` output into your agent config.
9+
10+
## Configure the server
11+
12+
Add this server entry to your MCP client config:
13+
14+
```json
15+
{
16+
"mcpServers": {
17+
"intent": {
18+
"command": "npx",
19+
"args": ["-y", "@tanstack/intent-mcp"]
20+
}
21+
}
22+
}
23+
```
24+
25+
Some clients use `servers` instead of `mcpServers`, but the server command is the same:
26+
27+
```json
28+
{
29+
"servers": {
30+
"intent": {
31+
"command": "npx",
32+
"args": ["-y", "@tanstack/intent-mcp"]
33+
}
34+
}
35+
}
36+
```
37+
38+
Run the server from your project root so Intent can discover the project's installed packages.
39+
40+
## Use skills
41+
42+
After the MCP server is connected, ask your agent to work normally.
43+
44+
When the task matches installed package skills, the agent can:
45+
46+
- call `intent_search` to find relevant skills
47+
- call `intent_load` to load one exact skill
48+
- call `intent_status` to inspect package and skill counts
49+
50+
The server is read-only. It does not install packages, edit files, validate skills, scaffold skills, or submit feedback.
51+
52+
## Tools
53+
54+
- `intent_search` returns compact JSON and defaults to five results.
55+
- `intent_load` returns one skill in a `<skill_content>` block.
56+
- `intent_status` returns package and skill counts.
57+
- `debug: true` returns expanded debug metadata and bypasses the process cache.
58+
59+
## Related
60+
61+
- [Quick Start for Consumers](./quick-start-consumers)
62+
- [intent list](../cli/intent-list)
63+
- [intent load](../cli/intent-load)

0 commit comments

Comments
 (0)