用于FAQsimple的MCP服务器
使AI助手能够通过模型上下文协议（MCP）访问和引用您的常见问题解答内容
此MCP服务器为像Claude这样的AI助手提供了对您的FAQsimple知识库的无缝访问，允许他们在回复中搜索、检索和引用权威的FAQ内容。
🚀 快速开始
先决条件
- Node.js 18或更高版本
- npm 9或更高版本
- 具有API证书的FAQsimle帐户
安装
选项1:NPX（推荐）
最简单的开始方法：
npx mcp-server-faqsimple选项2：全局安装
npm install -g mcp-server-faqsimple选项3：本地安装
npm install mcp-server-faqsimple配置
1.获取API密钥
从您的FAQimple仪表板或支持请求API密钥。
2.配置克劳德桌面
将服务器添加到Claude Desktop配置文件中：
macOS/Linux： ~/Library/Application Support/Claude/claude_desktop_config.json 窗户： %APPDATA%/Claude/claude_desktop_config.json
{
"mcpServers": {
"faqsimple": {
"command": "npx",
"args": ["-y", "mcp-server-faqsimple"],
"env": {
"FAQSIMPLE_API_KEY": "fs.your.api.key.here"
}
}
}
}3.环境变量
| 变量 | 必填 | 默认 | 描述 |
|---|---|---|---|
FAQSIMPLE_API_KEY | ✅ 是 | - | 您的FAQsimle API密钥（以开头 fs.) |
FAQSIMPLE_API_BASE | 没有 | https://api.faqsimple.io/v1 | API基本URL |
CACHE_TIMEOUT | 没有 | 300000 | 缓存超时（毫秒）（5分钟） |
RATE_LIMIT_DELAY | 没有 | 1000 | 请求之间的延迟（毫秒） |
🛠️ 特性
🔍 智能搜索
- 同时搜索所有可访问的常见问题
- 基于问题/答案权重的相关性评分
- 模糊匹配以获得更好的结果
📚 完整的FAQ访问
- 使用格式化的markdown检索完整的常见问题解答内容
- 访问所有问题、答案和元数据
- 保留原始格式和结构
⚡ 性能优化
- 内置缓存以减少API调用
- 速率限制合规性
- 高效的批处理操作
🔒 安全可靠
- 基于环境变量的配置
- 全面的错误处理
- API密钥验证
📖 使用示例
基本搜索
You: Can you help me find information about password resets in our FAQ?
Claude: I'll search through your FAQ content for password reset information.
[Claude uses the search_faqs tool automatically]
Based on your FAQ content, here's what I found about password resets:
**1. Product Support FAQ**
**Question:** How do I reset my password?
To reset your password:
1. Go to the **login page**
2. Click "Forgot Password"
3. Enter your email address
4. Check your email for reset instructions
*Note: Reset links expire after 24 hours.*
This information comes directly from your authoritative FAQ source (FAQ001).获取具体常见问题
You: Show me all content from FAQ001
Claude: [Uses get_faq_content tool with FAQ001]
# Product Support FAQ
This FAQ covers common questions about our product features and troubleshooting.
**Public URL:** https://help.yourcompany.com/faq001
**Last Updated:** 2024-01-15T10:30:00Z
**Questions:** 15
## 1. How do I reset my password?
[Full content with all Q&As...]列出可用常见问题
You: What FAQs do you have access to?
Claude: [Uses list_faqs tool]
I have access to 3 FAQs:
**Product Support FAQ** (FAQ001)
Covers common questions about product features and troubleshooting
URL: https://help.yourcompany.com/faq001
**Billing & Subscriptions** (FAQ002)
Information about billing, payments, and subscription management
URL: https://help.yourcompany.com/faq002
**API Documentation FAQ** (FAQ003)
Technical questions about API integration and development
URL: https://help.yourcompany.com/faq003🔧 可用工具
MCP服务器提供三个主要工具：
search_faqs
在所有可访问的常见问题中按问题或关键字搜索常见问题内容。
参数：
query（字符串，必填）：搜索查询limit（数字，可选）：最大结果（1-50，默认值：10）
get_faq_content
获取完整的常见问题解答内容，包括所有问题和答案。
参数：
faq_number（字符串，必填）：常见问题解答编号（例如“FAQ001”）
list_faqs
列出所有可访问的常见问题及其基本信息。
参数： 无
📁 资源
服务器将FAQ内容作为MCP资源公开：
- URI格式：
faq://FAQ001,faq://FAQ002等等。 - MIME类型：
text/markdown - 内容： 以markdown格式完成常见问题解答内容
🏗️ 发展
地方发展
# Clone the repository
git clone https://github.com/CJK-Technologies/mcp-server-faqsimple.git
cd mcp-server-faqsimple
# Install dependencies
npm install
# Set your API key
export FAQSIMPLE_API_KEY="fs.your.api.key.here"
# Run in development mode
npm run dev建筑
# Build TypeScript
npm run build
# Run built version
npm start测试
# Run tests
npm test
# Run tests in watch mode
npm run test:watch
# Run with coverage
npm run test:coverage🤝 贡献
我们欢迎捐款！请查看我们的 贡献指南 了解详情。
快速贡献步骤
- 分叉存储库
- 创建要素分支(
git checkout -b feature/amazing-feature) - 进行更改
- 添加新功能的测试
- 运行测试套件(
npm test) - 提交您的更改(
git commit -m 'Add amazing feature') - 推到分支(
git push origin feature/amazing-feature) - 打开拉取请求
📄 许可证
此项目根据Apache 2.0许可证获得许可-请参阅 许可证 文件以获取详细信息。
🐛 问题与支持
- Bug报告：
- 功能请求：
- 文档： FAQ文档
🔄 更新日志
看 更改日志.md 查看详细的变化历史。
🌟 相关项目
______________________________________________________________________
内置于❤️ 对于FAQsimple和MCP社区
*这是一个开源项目；它并不完美，但它试图为MCP集成提供坚实的基础。*