Stimulsoft Documentation MCP Server
官方Stimulsoft Reports & Dashboards 文档的官方 MCP 服务器。跨 FAQ、编程手册、服务器/用户手册以及服务器/云 API 进行语义搜索,支持 .NET、WPF、Avalonia、WEB、Blazor、Angular、React、JS、PHP、Java 和 Python 平台。
你可以用 Stimulsoft Documentation MCP 做什么?
- 发现平台 — 询问索引中包含哪些 Stimulsoft 平台,
sti_get_platforms会返回这些平台的 ID,供搜索筛选使用。 - 搜索文档 — 用任意语言提问,
sti_search会返回按相关性排序的结果,其中包含平台、类别、内容和代码片段。 - 按平台筛选 — 将结果限定为
WPF、BLAZOR、ANGULAR、REACT、JS、PHP、JAVA、PYTHON或SERVER_API等技术栈。 - 按类别筛选 — 将搜索范围限定为
faq、programming_manual、server_manual、user_manual、server_api或cloud_api。 - 控制结果数量 — 设置
limit以限制返回的结果数量(默认值为 5,最大值为 20)。
文档
Stimulsoft Documentation MCP Server 可将 AI 助手直接连接到 Stimulsoft 官方 Reports & Dashboards 开发者文档。配置完成后,处于 Agent 模式的 AI 助手可以搜索文档、查找代码示例,并使用最新信息生成 Stimulsoft 专用代码,而不必依赖可能已经过时的训练数据。
端点: https://devs.stimulsoft.com/mcp-docs
协议: MCP 2025-03-26,Streamable HTTP
身份验证: 无需身份验证 重要
请始终检查 AI 生成的输出:检查是否存在架构问题、安全漏洞,以及是否符合项目标准。AI 生成的输出可能因提示词、所用 AI 模型和项目代码的清晰程度而有很大差异。
先决条件
支持的 IDE: Visual Studio 2022+、Visual Studio Code、Cursor、JetBrains Rider 2025.1+
兼容的 AI 工具: GitHub Copilot、JetBrains AI Assistant、Claude Desktop、Claude Code (CLI)、ChatGPT (Plus/Team/Enterprise)、Gemini CLI,以及其他兼容 MCP 的助手
可用工具
| 工具 | 描述 |
|---|---|
sti_get_platforms | 返回所有已索引 Stimulsoft 平台及其 ID 的列表。用于查找有效的 platform 值,以筛选搜索结果。无需 API 调用 — 即时响应。 |
sti_search | 在完整文档索引(FAQ、Programming Manual、Server Manual、User Manual、Server API、Cloud API)中进行语义搜索。接受任何语言的查询。返回按相关性排序的结果,包括平台、类别、内容(含代码片段)和相关性评分。 |
sti_search 参数
| 参数 | 必填 | 描述 |
|---|---|---|
query | 是 | 要搜索的问题或主题,支持任何语言 |
platform | 否 | 筛选条件:.NET、WPF、AVALONIA、WEB、BLAZOR、ANGULAR、REACT、JS、PHP、JAVA、PYTHON、SERVER_API、GENERAL |
category | 否 | 筛选条件:faq、programming_manual、server_manual、user_manual、server_api、cloud_api |
limit | 否 | 最大结果数(默认 5,最大 20) |
常见设置步骤
- 启用 Agent 模式(如果 IDE 要求)。
- 将服务器端点添加到 MCP 配置中(请参阅下方说明)。
- 验证连接:确认
sti_get_platforms和sti_search出现在 AI 助手的可用工具中。 - 设置自定义指令(可选),以优化助手对 Stimulsoft 工具的使用。
按 IDE / 工具设置
Visual Studio 2022 / 2026
在 %USERPROFILE% 目录中创建或编辑 .mcp.json:
{
"servers": {
"stimulsoft-docs": {
"type": "http",
"url": "https://devs.stimulsoft.com/mcp-docs"
}
}
}
VS Code
使用 命令面板 → MCP: Add Server,或创建 <project>/.vscode/mcp.json:
{
"servers": {
"stimulsoft-docs": {
"type": "http",
"url": "https://devs.stimulsoft.com/mcp-docs"
}
}
}
或者,在项目根目录中创建 .mcp.json:
{
"mcpServers": {
"stimulsoft-docs": {
"type": "http",
"url": "https://devs.stimulsoft.com/mcp-docs"
}
}
}
Cursor
创建 <project>/.cursor/mcp.json,或前往 Settings → Tools & Integrations → New MCP Server:
{
"mcpServers": {
"stimulsoft-docs": {
"type": "http",
"url": "https://devs.stimulsoft.com/mcp-docs"
}
}
}
JetBrains Rider
前往 Settings → Tools → AI Assistant → Model Context Protocol (MCP),点击 +,选择 HTTP 协议并填写:
{
"stimulsoft-docs": {
"type": "http",
"url": "https://devs.stimulsoft.com/mcp-docs"
}
}
Claude Desktop
打开 Settings → Connectors → Add custom connector:
- 名称: Stimulsoft Documentation
- URL: https://devs.stimulsoft.com/mcp-docs
- 身份验证::无需身份验证
或者直接编辑 claude_desktop_config.json:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"stimulsoft-docs": {
"type": "http",
"url": "https://devs.stimulsoft.com/mcp-docs"
}
}
}
Claude Code (CLI)
# Local configuration
claude mcp add --transport http stimulsoft-docs https://devs.stimulsoft.com/mcp-docs
# Global configuration
claude mcp add --scope user --transport http stimulsoft-docs https://devs.stimulsoft.com/mcp-docs
# Verify registered servers
claude mcp list
GitHub Copilot (coding agent)
前往 Repository → Settings → Copilot → Coding agent,并在“MCP configuration”部分添加:
{
"stimulsoft-docs": {
"type": "http",
"url": "https://devs.stimulsoft.com/mcp-docs",
"tools": ["*"]
}
}
ChatGPT
打开 Settings → Connectors → Advanced settings,启用 Developer mode,然后选择 Create connector:
- 名称: Stimulsoft Documentation
- URL: https://devs.stimulsoft.com/mcp-docs
- 身份验证: 无需身份验证
信任该应用并点击 Create。
Gemini CLI
添加到 .gemini/settings.json:
{
"Stimulsoft Docs MCP Server": {
"httpUrl": "https://devs.stimulsoft.com/mcp-docs"
}
}
提问最佳实践
要从 Stimulsoft Documentation MCP Server 获取最相关的结果:
- 明确指定组件。 提及确切的类名:
StiReport、StiViewer、StiDesigner、StiBlazorViewer、StiWebViewer、StiNetCoreViewer。 - 说明技术栈。 指定平台:WinForms、WPF、Avalonia、ASP.NET Core、Blazor、Angular、React、JS、PHP、Java、Python。
- 需要时明确要求提供代码示例。
- 提及 MCP 服务器。 使用“Use stimulsoft-docs”“search Stimulsoft docs”或“according to Stimulsoft documentation”等短语。
提示词示例:
- 如何在 Blazor 中将报表导出为 PDF?使用 stimulsoft-docs。
- 展示如何在 Angular 中将 StiReport 连接到 REST API 数据源。搜索 Stimulsoft 文档。
- 如何在 ASP.NET Core 中自定义 StiWebViewer 工具栏按钮?
- 创建一个包含 StiViewer 的 WPF 窗口,并显示来自文件的报表。使用 stimulsoft-docs。
- 如何在 C# 中以编程方式向 StiReport 添加计算列?
优化 AI 助手
设置自定义指令,指导 AI 助手如何使用 Stimulsoft 工具。
GitHub Copilot (VS Code, Visual Studio, JetBrains Rider)
创建或编辑 <project>/.github/copilot-instructions.md:
---
description: 'Answer questions about Stimulsoft Reports & Dashboards using the stimulsoft-docs MCP server'
---
You are a developer expert in Stimulsoft Reports & Dashboards.
When replying to ANY question about Stimulsoft components, use the stimulsoft-docs MCP server.
## Workflow:
1. Call sti_get_platforms if the target platform is unclear
2. Call sti_search to find relevant documentation sections
3. Provide a comprehensive answer based on retrieved information
## Constraints:
- Answer questions based solely on information from the MCP server
- Include code examples from documentation when available
- Reference specific Stimulsoft classes, properties, and methods
- Specify the platform (NET, WPF, BLAZOR, etc.) in search queries
Cursor
前往 Settings → Rules & Memories,并添加一条内容类似的规则。
Claude Desktop
创建一个 Project(Projects → New Project),为其命名,点击 Set custom instructions,并添加与上述示例类似的指南。Stimulsoft MCP 连接器将在此项目的所有对话中可用。
Claude Code
在项目根目录中创建 CLAUDE.md:
# Stimulsoft Development Instructions
When working with Stimulsoft Reports & Dashboards:
- Always use the stimulsoft-docs MCP server to search documentation
- Reference specific Stimulsoft class names (StiReport, StiViewer, etc.)
- Include technology stack (WinForms, WPF, Blazor, ASP.NET Core, Angular, React, JS, PHP, Java, Python)
- Follow Stimulsoft best practices from official documentation
支持的平台
Reports.NET (WinForms)、Reports.WPF、Reports.AVALONIA、Reports.WEB (ASP.NET / ASP.NET Core / MVC)、Reports.BLAZOR (Server & WebAssembly)、Reports.ANGULAR、Reports.REACT、Reports.JS、Reports.PHP、Reports.JAVA (Java SE & Jakarta EE)、Reports.PYTHON 和 Stimulsoft Server API。
验证连接
打开浏览器并访问 https://devs.stimulsoft.com/mcp-docs — 你应该会看到一条纯文本横幅,确认服务器正在运行。
或者使用 curl 测试:
curl -X POST https://devs.stimulsoft.com/mcp-docs \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'
响应中应包含 sti_get_platforms 和 sti_search 两个工具定义。