xinyangkb_mcp
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@xinyangkb_mcpTM52F1376 的规格参数是什么?"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Xinyang KB MCP
芯阳内部知识库 MCP 服务,同时支持 Codex 和 OpenCode。
环境要求
Node.js 18+
Codex CLI 和/或 OpenCode
可访问芯阳内部搜索 API
仓库已提交独立运行产物 plugins/xinyang-kb/dist/index.js。使用者安装时不需要执行 npm install。
Related MCP server: yunwen-doc-ai-platform
一键安装
搜索 API 地址默认为 http://10.1.120.36:5010/search,无需显式提供即可安装:
node scripts/install.cjs安装器会自动检测 Codex 和 OpenCode,并保留未涉及的现有配置。修改已有 JSON 配置前会生成带时间戳的备份。
可选参数:
参数 | 说明 |
| 覆盖默认搜索地址 |
| 显式指定基础地址;默认从 |
| 直接注册 Codex MCP,默认模式 |
| 通过本仓库 Marketplace 安装 Codex 插件 |
| 同时安装两种 Codex 接入方式 |
| 跳过 Codex |
| 跳过 OpenCode |
| 显式写入 MCP 的 |
Windows
.\scripts\install.ps1Linux / macOS
./scripts/install.sh更换搜索地址(无需重装)
安装完成后,如需切换到其他知识库地址,运行一行命令即可,无需重新执行安装流程:
node scripts/set-url.cjs http://10.1.120.36:5010/search脚本会直接更新运行时配置 ~/.config/xinyang-kb/config.json,并自动备份原文件。
基础地址自动推导:
当 URL 以
/search/dify或/search结尾时,基础地址自动取去掉该后缀的部分。node scripts/set-url.cjs http://10.1.120.36:5010/search # searchApiUrl = http://10.1.120.36:5010/search # apiServerBaseUrl = http://10.1.120.36:5010否则基础地址与搜索地址相同。
node scripts/set-url.cjs http://10.1.120.36:5010/custom # searchApiUrl = apiServerBaseUrl = http://10.1.120.36:5010/custom
如需显式指定基础地址,追加 --api-base:
node scripts/set-url.cjs http://10.1.120.36:5010/custom/search --api-base http://10.1.120.36:5010更新完成后重启 Codex/OpenCode 并新建会话即可生效。
Codex
直接注册
默认安装方式。安装器执行 codex mcp add,并将 Skill 安装到 ~/.codex/skills/xinyang-assistant。
node scripts/install.cjs --codex-mode direct --no-opencode插件安装
仓库采用标准 Marketplace 布局:
.agents/plugins/marketplace.json
plugins/xinyang-kb/安装命令:
node scripts/install.cjs --codex-mode plugin --no-opencode插件同时携带 MCP 和 xinyang-assistant Skill。安装完成后请重启 Codex 并新建会话。
OpenCode
OpenCode 继续使用已验证的配置格式:
配置文件:
~/.config/opencode/opencode.jsonMCP 类型:
local环境字段:
environmentSkill:
~/.config/opencode/skills/xinyang-assistant/SKILL.md(由 OpenCode 的skill工具自动发现,无需在instructions中引用)
仅安装 OpenCode:
node scripts/install.cjs --no-codex安装器会合并已有 JSON,不覆盖其他 MCP 或用户设置。升级时还会自动清理旧版的单文件 skill 及其 instructions 引用。若原配置不是有效 JSON,安装会停止且不会覆盖文件。
配置
搜索 API 默认地址为 http://10.1.120.36:5010/search。运行时可通过以下方式自定义(优先级从高到低):
工具调用参数
search_api_url(单次调用覆盖)SEARCH_API_URL、API_SERVER_BASE_URL环境变量~/.config/xinyang-kb/config.json内置默认值
http://10.1.120.36:5010/search
当只提供 SEARCH_API_URL 时,API_SERVER_BASE_URL 会自动从其中推导(若以 /search/dify 或 /search 结尾则截取基础地址,否则与搜索地址相同)。
插件模式使用用户配置文件;直接注册模式同时注入环境变量。
卸载
Codex
如果使用 direct 模式安装:
codex mcp remove xinyang-kb然后删除 Skill:
~/.codex/skills/xinyang-assistant/如果使用 plugin 模式安装:
codex plugin remove xinyang-kb@xinyang-internal如不再使用本仓库 Marketplace,可继续执行:
codex plugin marketplace remove xinyang-internalboth 模式需要同时执行 direct 和 plugin 两组卸载操作。
OpenCode
编辑 ~/.config/opencode/opencode.json,删除 mcp 中的 xinyang-kb。
然后删除 skill 目录:
~/.config/opencode/skills/xinyang-assistant/共享运行配置
确认 Codex 和 OpenCode 都不再使用本 MCP 后,可删除:
~/.config/xinyang-kb/config.json卸载后重启 Codex 或 OpenCode,并新建会话。
开发与验证
npm ci
npm run typecheck
npm run build常用检查:
codex mcp list
codex plugin marketplace list
codex plugin list
opencode mcp list工具
knowledge_base_search 用于搜索芯阳内部产品参数、技术方案、制度、流程、项目和内部文档。返回结果中的内部文档路径会转换为可引用 URL。
参数:
参数 | 说明 |
| 必填,知识库检索关键词 |
| 可选,覆盖本次调用的搜索 API 地址,默认 |
Available Tools
1 toolknowledge_base_searchA
搜索芯阳公司内部知识库。当用户询问芯阳内部产品参数、技术方案、公司制度、流程、项目信息时,必须使用此工具。禁止直接 curl 或 fetch 调用后端 API,必须通过本工具查询。默认搜索地址为 http://10.1.120.36:5010/search,可通过 search_api_url 参数自定义。
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | The search query to look up in the knowledge base | |
| search_api_url | No | Optional override for the search API URL. Defaults to http://10.1.120.36:5010/search. Use this to point at a different knowledge base search endpoint. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden of behavioral disclosure. It adds useful context by revealing the default backend URL and the ability to override it via a parameter, plus a rule against direct API calls. However, it does not disclose return format, error handling, or whether the operation is read-only, leaving some important behavioral aspects undisclosed.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences long, front-loaded with the core purpose in the first sentence. Every sentence serves a distinct function: purpose, usage guidance, and configuration detail. There is no redundancy or filler, making it optimally concise.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is simple (2 parameters, no output schema, no annotations), and the description adequately covers purpose, usage, and endpoint configuration. However, it omits information about response format or potential error scenarios, which would be helpful for an agent to correctly interpret results. The absence of this detail is a noticeable gap, but not critical for a basic search tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema already provides descriptions for both parameters (query and search_api_url), achieving 100% schema coverage. The description's mention of the default URL and configurability simply restates what the parameter description already says, adding no novel semantic information beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's function with a specific verb ('search') and resource ('Xinyang internal knowledge base'), and further clarifies scope by listing example content types (product parameters, technical solutions, company policies, etc.). This makes the tool's purpose unmistakable even without sibling tools to differentiate from.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit when-to-use guidance: 'must use this tool' when users ask about internal knowledge topics. It also explicitly prohibits alternative actions (direct curl/fetch calls to the backend API), leaving no ambiguity about the correct invocation path.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections. Dates show when Glama detected each change.
1 tool update
v1.0.0- First observed
knowledge_base_search
TDQS
Only one tool exists, so there is no possibility of confusing it with another. The tool's purpose is clearly defined as searching the knowledge base.
With only one tool, naming consistency is trivially satisfied. The name 'knowledge_base_search' is descriptive and unambiguous.
A single tool feels thin for a knowledge base server, but it may be appropriate if the sole purpose is search. It's on the borderline, as 1-2 tools are considered minimal.
The tool covers the core search functionality well, but lacks management operations like add, update, or delete. For a search-only server, this is relatively complete, though minor gaps exist.
Maintenance
Resources
Unclaimed servers have limited discoverability.
Looking for Admin?
If you are the server author, to access and configure the admin panel.
Related MCP Connectors
MCP server for querying Forkast documentation
Personal knowledge base MCP server with semantic search, auto-categorization, metadata extraction
DocBase MCP server for AI agents
Related MCP Servers
- FlicenseBqualityDmaintenanceA local MCP server that allows AI systems to search and retrieve information from a custom knowledge base generated from markdown files. It provides tools for natural language text search, category browsing, and specific content chunk retrieval.3-
- FlicenseNot gradedqualityBmaintenance提供文档智能问答的MCP服务器,支持查询知识库、获取会话历史和清理会话历史。3-
- FlicenseNot gradedqualityBmaintenanceA local RAG knowledge base MCP server that exposes semantic document search as tools using zvec for vector storage and Qwen3-Embedding for text embedding.-
- FlicenseNot gradedqualityBmaintenanceLocal MCP server for GaussDB documentation semantic search and read-only database introspection.-
Latest Blog Posts
- Who's Calling? MCP Hosts Are an Identity Blind Spot (And the Spec Knows It)By Om-Shree-0709 on .mcpAgent IdentityOAuth 2.1
- Your AI Chatbot Just Exposed Your CEO's Salary to an InternBy Om-Shree-0709 on .Agent IdentityMCP SecurityOAuth Delegation
- Why MCP Servers Need Execution Sandboxing (And Why Your Current Stack Isn't Enough)By Om-Shree-0709 on .Agentic AiPrompt InjectionWebAssembly
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/chengyangliu-lcy/xinyangkb_mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server