Template
feat: initial MCP server template with placeholder-driven scaffolding
Template repository for creating MokoStandards-compliant MCP servers.
Includes 4-file src/ structure (index, client, config, types), setup
wizard, example tools, 12 CI/CD workflows, full docs, and {{placeholder}}
tokens for search-and-replace customization.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
+63
@@ -0,0 +1,63 @@
|
||||
<!--
|
||||
Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
|
||||
SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
# FILE INFORMATION
|
||||
DEFGROUP: {{PROJECT_NAME}}.Documentation
|
||||
PATH: /docs/API.md
|
||||
VERSION: 01.00.00
|
||||
BRIEF: MCP tool reference documentation
|
||||
-->
|
||||
|
||||
# API Reference
|
||||
|
||||
All tools accept an optional `connection` parameter to target a specific named connection. If omitted, the default connection is used.
|
||||
|
||||
## Example Resources
|
||||
|
||||
> Replace these example tools with your actual API tools.
|
||||
|
||||
### `example_resources_list`
|
||||
List resources with optional search.
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
|-----------|------|----------|-------------|
|
||||
| `search` | string | No | Search query |
|
||||
| `limit` | number | No | Max results |
|
||||
| `page` | number | No | Page number (0-based) |
|
||||
|
||||
### `example_resource_get`
|
||||
Get a single resource by ID.
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
|-----------|------|----------|-------------|
|
||||
| `id` | number | Yes | Resource ID |
|
||||
|
||||
### `example_resource_create`
|
||||
Create a new resource.
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
|-----------|------|----------|-------------|
|
||||
| `name` | string | Yes | Resource name |
|
||||
| `description` | string | No | Resource description |
|
||||
|
||||
## Generic
|
||||
|
||||
### `api_request`
|
||||
Make a raw API request to any endpoint.
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
|-----------|------|----------|-------------|
|
||||
| `method` | `"GET"` / `"POST"` / `"PUT"` / `"PATCH"` / `"DELETE"` | Yes | HTTP method |
|
||||
| `endpoint` | string | Yes | API path |
|
||||
| `body` | object | No | Request body |
|
||||
| `params` | object | No | Query parameters |
|
||||
|
||||
### `list_connections`
|
||||
List all configured connections. No parameters.
|
||||
|
||||
## Revision History
|
||||
|
||||
| Date | Version | Author | Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| 2026-05-07 | 0.0.1 | jmiller | Initial template API reference |
|
||||
Reference in New Issue
Block a user