mcp-server-example
Click on "Deploy 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., "@mcp-server-exampleWhich readers support BLE and how do I subscribe to events?"
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.
mcp-server-example
A minimal Model Context Protocol server in TypeScript. It exposes a small device catalog and SDK method reference to AI agents through three read-scoped tools, so an integrator can ask an agent questions like "which readers support BLE?" or "how do I subscribe to access events?" instead of reading documentation.
This is a sanitized, self-contained echo of a pattern I've used in production: put an MCP server in front of an SDK so third-party integrators can build against it through an agent.
The design point
The tool schemas are the governance layer. There is deliberately no unlock_door tool in this server. An agent connected to it can list devices, get device details, and search SDK methods, and nothing else. "What can the AI do?" becomes a precise, auditable question answered by the schema, not by trusting the model to behave.
Related MCP server: docrag
Tools
Tool | Scope |
| Read. Optional filters by category and capability |
| Read. Single device by id |
| Read. Keyword search over SDK method reference |
Run it
npm install
npm run inspect # opens the MCP Inspector against this serverOr wire it into Claude Desktop / Cursor as a stdio server:
{
"mcpServers": {
"example": { "command": "npx", "args": ["tsx", "/path/to/mcp-server-example/src/index.ts"] }
}
}Then ask: "Which readers support BLE and what SDK call subscribes to events?" and watch the agent chain list_devices and search_sdk.
What I'd add for a real deployment
An HTTP transport (SSE or streamable HTTP) for remote clients, with auth on the transport
Per-client scoping: which tools a given integrator's token can see
Audit logging of every tool invocation (who, what, when, arguments)
Write-scoped tools only behind explicit approval workflows
Available Tools
3 toolsget_deviceA
Get full details for a single device by id.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description is the sole source of behavioral disclosure. The verb 'get' implies a read-only, non-destructive operation, but it does not explain error behavior (e.g., unknown ID), response format, or auth requirements. This is adequate for a simple retrieval but lacks depth.
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 a single, front-loaded sentence with no wasted words. It immediately communicates the action and target, making it easy to parse.
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?
For a one-parameter read tool with no output schema, the description covers the essential invocation and high-level return intent. However, it leaves ambiguity about what 'full details' includes and lacks any edge-case or error context, so completeness is only moderate.
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?
Schema description coverage is 0%, so the description must compensate. It only references 'id' in the phrase 'by id', adding minimal meaning beyond the parameter name and type in the schema. No format, constraints, or guidance on how to obtain a valid id is given.
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 states a specific verb ('get'), a clear resource ('full details for a single device'), and the selection mechanism ('by id'). This distinguishes it from list_devices (multiple devices) and search_sdk (generic search) without needing to open the schema.
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?
It clearly implies the right context: use when you have a specific device ID and need comprehensive details. However, it does not explicitly mention alternatives or exclusions, so it stops short of full guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_devicesA
List catalog devices. Optional filters: category (reader|controller|camera) and capability (e.g. 'ble', 'osdp').
| Name | Required | Description | Default |
|---|---|---|---|
| category | No | ||
| capability | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It reveals that this is a listing operation but does not mention pagination, result limits, ordering, authentication needs, or how missing filters behave. The optional filter semantics are useful but more parameter-related than behavioral.
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 a single, tightly written sentence. The primary action is front-loaded, and the optional filter details are concise without any filler.
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?
For a simple read-only listing tool with two optional parameters, the description is mostly adequate. However, there is no output schema and no mention of pagination or response shape, so an agent may not know how many results to expect or whether results are paginated.
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?
Schema description coverage is 0%, so the description must compensate. It names both parameters, identifies them as optional, gives the valid category enum values, and provides concrete capability examples ('ble', 'osdp'), adding practical meaning beyond the raw 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 states a specific verb and resource ('List catalog devices') and clearly distinguishes it from the sibling get_device, which retrieves a single device, and search_sdk, which searches SDKs. The scope is unambiguous.
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 implies when to use the tool: when you want a list of catalog devices, optionally filtered. However, it does not explicitly mention alternatives or when not to use it, leaving the agent to infer the distinction from sibling names.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
search_sdkA
Search SDK methods by keyword across name and description. Returns name, description, and the SDK version it appeared in.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden of disclosing behavioral traits. It only mentions the return format, not whether the operation is read-only, requires any permissions, or has side effects. For a search tool, this is a minimal gap, but without annotations, more context would be expected to assure the agent of safety or any limitations.
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 a single, front-loaded sentence that states the action, scope, and return values with no filler. Every clause contributes useful information, making it highly efficient.
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?
For a simple search tool with one parameter and no output schema, the description covers the essential operation and return format. It does not mention details like case sensitivity, matching behavior, or pagination, but these are not critical for a basic search. The absence of annotations and output schema is partially offset by the clear description, though some behavioral nuance is missing.
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 schema has a single parameter 'query' with zero description coverage. The tool description explains that the query is a keyword searched across name and description, which gives meaningful context beyond the schema's bare type string. This compensates well for the lack of parameter documentation.
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: searching SDK methods by keyword across name and description, and it specifies the return fields (name, description, SDK version). This is a specific verb+resource that distinguishes it from sibling tools like list_devices and get_device, which serve different purposes.
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 does not explicitly mention alternatives or when to use this tool versus the siblings. However, the action of searching is clear, and an agent could infer that this is for finding a specific method rather than listing all devices. It lacks explicit exclusions or alternative routing, so it falls into 'implied usage' rather than clear guidance.
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.
3 tool updates
v0.1.0- First observed
get_device - First observed
list_devices - First observed
search_sdk
TDQS
Scored across 3 tools
Each tool targets a distinct operation: listing devices, retrieving a device detail, and searching SDK methods. No two tools overlap in purpose or output, so an agent can easily select the right one.
All tool names follow a clear lower_snake_case verb_noun pattern: list_devices, get_device, search_sdk. The convention is perfectly consistent across the set.
Three tools is on the smaller side, but the server appears focused on read-only device catalog and SDK lookup. The count is reasonable for a narrow purpose, though it might feel slightly thin if the server expected broader functionality.
For the implied read-only catalog use case, the coverage is adequate: list and get cover device data, and search covers SDK exploration. Missing create/update/delete operations are acceptable if the server is intentionally read-only, but a get_sdk_method or list_sdk_methods would round out the SDK side.
Maintenance
Related MCP Connectors
Read-only MCP tools for AI agent discovery, structured resources, and NIULAI information.
Let AI agents query data and act across all your business apps via MCP.
Make your knowledge agent-ready. One MCP endpoint, 5 connectors, 3 search modes.
Read-only AgentiScript concept search, catalog, authenticity, license, and approved asset discovery.
Related MCP Servers
- AlicenseNot gradedqualityBmaintenanceEnables AI agents to search, read, and traverse documentation bundles in Open Knowledge Format via MCP tools.233 npm72MIT
- AlicenseNot gradedqualityDmaintenanceProvides RAG (Retrieval Augmented Generation) access to technical documentation through MCP, enabling LLMs to search and retrieve relevant documentation on-demand.4MIT
- AlicenseNot gradedqualityBmaintenanceEnables AI assistants to query an organization's device posture, compliance, policies, and software/CVE status through a remote, read-only, OAuth-secured MCP endpoint.MIT
- FlicenseNot gradedqualityBmaintenanceEnables to build and query a knowledge base with retrieval-augmented generation, supporting document ingestion, hybrid search, and live data integration from external APIs via MCP tools.2-